git: 713d74907d70 - main - www/xcaddy: Add rc(8) script
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 29 Sep 2022 15:43:20 UTC
The branch main has been updated by adamw:
URL: https://cgit.FreeBSD.org/ports/commit/?id=713d74907d70e27aa27264cbbe03e92bbca7e250
commit 713d74907d70e27aa27264cbbe03e92bbca7e250
Author: Adam Weinberger <adamw@FreeBSD.org>
AuthorDate: 2022-09-29 15:38:38 +0000
Commit: Adam Weinberger <adamw@FreeBSD.org>
CommitDate: 2022-09-29 15:43:03 +0000
www/xcaddy: Add rc(8) script
Bring in the rc(8) script from caddy to xcaddy so that xcaddy users
can control caddy like an adult.
Add CONFLICTS between xcaddy and caddy because they now install the
same rc(8) script. There's no reason to change the install path here
because, as olgeni put it, "xcaddy with plugins is more caddy than
caddy".
Suggested by: bdrewery
Approved by: olgeni (xcaddy maintainer)
---
www/caddy/Makefile | 2 +
www/xcaddy/Makefile | 8 ++-
www/xcaddy/files/caddy.in | 127 ++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 136 insertions(+), 1 deletion(-)
diff --git a/www/caddy/Makefile b/www/caddy/Makefile
index 14629b7b0cbf..b2b10dce42cb 100644
--- a/www/caddy/Makefile
+++ b/www/caddy/Makefile
@@ -18,6 +18,8 @@ CPE_VENDOR= caddyserver
USE_RC_SUBR= caddy
SUB_FILES= Caddyfile.sample caddy pkg-message
+CONFLICTS_INSTALL= xcaddy
+
PLIST_FILES= bin/${PORTNAME} \
"@sample ${ETCDIR_REL}/Caddyfile.sample"
diff --git a/www/xcaddy/Makefile b/www/xcaddy/Makefile
index 899a586b7f7a..3bc889dbe9db 100644
--- a/www/xcaddy/Makefile
+++ b/www/xcaddy/Makefile
@@ -1,7 +1,7 @@
PORTNAME= xcaddy
DISTVERSIONPREFIX= v
DISTVERSION= 0.3.1
-PORTREVISION= 1
+PORTREVISION= 2
CATEGORIES= www
DIST_SUBDIR= xcaddy
@@ -14,6 +14,12 @@ LICENSE_FILE= ${WRKSRC}/LICENSE
USES= go:modules
+USE_RC_SUBR= caddy
+SUB_FILES= caddy
+SUB_LIST+= CADDYDIR="${PREFIX}/etc/caddy"
+
+CONFLICTS_INSTALL= caddy
+
USE_GITHUB= yes
GH_ACCOUNT= caddyserver
GH_TUPLE= Masterminds:semver:v3.1.1:masterminds_semver_v3/vendor/github.com/Masterminds/semver/v3 \
diff --git a/www/xcaddy/files/caddy.in b/www/xcaddy/files/caddy.in
new file mode 100644
index 000000000000..e1b137b37380
--- /dev/null
+++ b/www/xcaddy/files/caddy.in
@@ -0,0 +1,127 @@
+#!/bin/sh
+
+# PROVIDE: caddy
+# REQUIRE: LOGIN DAEMON NETWORKING
+# KEYWORD: shutdown
+
+# To enable caddy, add 'caddy_enable="YES"' to /etc/rc.conf or
+# /etc/rc.conf.local
+
+# Optional settings:
+# caddy_command (string): Full path to the caddy binary
+# caddy_config (string): Full path to caddy config file
+# (%%PREFIX%%/etc/caddy/Caddyfile)
+# caddy_adapter (string): Config adapter type (caddyfile)
+# caddy_directory (string): Root for caddy storage (ACME certs, etc.)
+# (/var/db/caddy)
+# caddy_extra_flags (string): Extra flags passed to caddy start
+# caddy_logdir (string): Where caddy logs are stored
+# (/var/log/caddy)
+# caddy_logfile (string): Location of process log (${caddy_logdir}/caddy.log)
+# This is for startup/shutdown/error messages.
+# To create an access log, see:
+# https://caddyserver.com/docs/caddyfile/directives/log
+# caddy_user (user): User to run caddy (root)
+# caddy_group (group): Group to run caddy (wheel)
+#
+# This script will honor XDG_CONFIG_HOME/XDG_DATA_HOME. Caddy will create a
+# .../caddy subdir in each of those. By default, they are subdirs of /var/db/caddy.
+# See https://caddyserver.com/docs/conventions#data-directory
+
+. /etc/rc.subr
+
+name=caddy
+rcvar=caddy_enable
+desc="Powerful, enterprise-ready, open source web server with automatic HTTPS written in Go"
+
+load_rc_config $name
+
+# Defaults
+: ${caddy_enable:=NO}
+: ${caddy_adapter:=caddyfile}
+: ${caddy_config:="%%PREFIX%%/etc/caddy/Caddyfile"}
+: ${caddy_command:="%%PREFIX%%/bin/${name}"}
+: ${caddy_directory:=/var/db/caddy}
+: ${caddy_extra_flags:=""}
+: ${caddy_logdir:="/var/log/${name}"}
+: ${caddy_logfile:="${caddy_logdir}/${name}.log"}
+: ${caddy_user:="root"}
+: ${caddy_group:="wheel"}
+
+# Config and base directories
+: ${XDG_CONFIG_HOME:="${caddy_directory}/config"}
+: ${XDG_DATA_HOME:="${caddy_directory}/data"}
+export XDG_CONFIG_HOME XDG_DATA_HOME
+
+caddy_flags="--config ${caddy_config} --adapter ${caddy_adapter}"
+pidfile="/var/run/${name}/${name}.pid"
+
+required_files="${caddy_config} ${caddy_command}"
+
+start_precmd="caddy_precmd"
+start_cmd="caddy_start"
+stop_precmd="caddy_prestop"
+
+# Extra Commands
+extra_commands="configtest reload"
+configtest_cmd="caddy_execute validate ${caddy_flags}"
+reload_cmd="caddy_execute reload ${caddy_flags}"
+
+caddy_execute()
+{
+ /usr/bin/su -m "${caddy_user}" -c "${caddy_command} $*"
+}
+
+caddy_precmd()
+{
+ # Create required directories and set permissions
+ /usr/bin/install -d -m 755 -o "${caddy_user}" -g "${caddy_group}" ${caddy_directory}
+ /usr/bin/install -d -m 700 -o "${caddy_user}" -g "${caddy_group}" ${caddy_directory}/config
+ /usr/bin/install -d -m 700 -o "${caddy_user}" -g "${caddy_group}" ${caddy_directory}/data
+ /usr/bin/install -d -m 755 -o "${caddy_user}" -g "${caddy_group}" ${caddy_logdir}
+ /usr/bin/install -d -m 700 -o "${caddy_user}" -g "${caddy_group}" /var/run/caddy
+ if [ -e ${caddy_logfile} ]; then
+ /bin/chmod 644 ${caddy_logfile}
+ /usr/sbin/chown root:wheel ${caddy_logfile}
+ else
+ /usr/bin/install -m 644 -o root -g wheel /dev/null ${caddy_logfile}
+ fi
+}
+
+caddy_start()
+{
+ echo -n "Starting caddy... "
+ /usr/bin/su -m ${caddy_user} -c "${caddy_command} start ${caddy_flags} \
+ ${caddy_extra_flags} --pidfile ${pidfile}" >> ${caddy_logfile} 2>&1
+ if [ $? -eq 0 ] && ps -ax -o pid | grep -q "$(cat ${pidfile})"; then
+ echo "done"
+ echo "Log: ${caddy_logfile}"
+ else
+ echo "Error: Caddy failed to start"
+ echo "Check the caddy log: ${caddy_logfile}"
+ fi
+}
+
+caddy_prestop()
+{
+ local result
+
+ echo -n "Stopping caddy... "
+
+ result="$(caddy_execute stop 2>&1)"
+ if [ ${?} -eq 0 ]; then
+ echo "done"
+ exit 0
+ else
+ if echo "${result}" | grep -q "connection refused"; then
+ echo "admin interface unavailable; using pidfile"
+ return 0
+ else
+ echo "Error: Unable to stop caddy"
+ echo "Check the caddy log: ${caddy_logfile}"
+ return 1
+ fi
+ fi
+}
+
+run_rc_command "$1"