On 2020/10/14 14:38, Aaron Poffenberger wrote:
> post-install:
> ln -s kcaldav ${WRKINST}${VARBASE}/www/cgi-bin/kcaldav.cgi
> + mkdir -p ${WRKINST}${VARBASE}/www/logs/
> + touch ${WRKINST}${VARBASE}/www/logs/kcaldav-system.log
> + chown www:www ${WRKINST}${VARBASE}/www/logs/kcaldav-system.log
chown is a noop here (builds are done as non-root)
> htdocs/kcaldav/style.css
> +@mode 775
> +@owner www
> +@group www
> +logs/kcaldav-system.log
and this will result in a checksum-error when the package is updated,
you either need to install a dummy empty file and use @sample:
logs/kcaldav-system.log.empty
@sample logs/kcaldav-system.log
or install at pkg_add time, probably something like this
@exec-add install -o www -g www -m 775 /var/www/logs/kcaldav-system.log
or, seeing as users need to follow the pkg-readme for setup anyway,
tell them to do it there.
(it might be better if it used syslog though.)
> - doas kcaldav.passwd -C -u <user> -e email -f /var/www/caldav
> - doas chown www:www /var/www/caldav/kcaldav.db
> - doas chmod 640 /var/www/caldav/kcaldav.db
> + $ doas kcaldav.passwd -C -u <user> -e email -f /var/www/caldav
> + $ doas chown www:www /var/www/caldav/kcaldav.db
> + $ doas chmod 640 /var/www/caldav/kcaldav.db
pkg-readmes are mixed, but for something like this which is
likely to be largely copy-and-pasted it's easier without the prefix
> + Remember to enable and start slowcgi(8). See rcctl(8).
might as well show the rcctl commands?
> +
> kcaldav.cgi uses http authentication for user security.
> Install a tls certificate to ensure privacy of connection.
> + See ssl(8) for details.
"tls certificate" nitpicking that should X.509 certificate,
and ssl(8) is not really helpful for the common case where somebody
just uses a letsencrypt client - might be better to say something
like this and leave it at that? needs more than just a certificate
installing, and the exact details depends on the type of webserver.
kcaldav.cgi uses http authentication for user security.
Make sure your web server is configured to use https to ensure
privacy of connection.
> +
>
> User Quick Start
> ================
> - Users can manage their account settings, create calendars
> + Users can manage their account settings, create calendars,
> and find the URL for use with their calendar application
> - by browsing to: https://localhost/kcaldav/home.html
> + by browsing to:
> +
> + https://example.org/kcaldav/home.html
> +
> + The URL will look like:
> +
> + https://example.org:/cgi-bin/kcaldav/<username>/
> +
stray : ? probably breaks some client or other ;)
>
> Porting Notes: Write Ahead Logging
> ==================================
> @@ -53,23 +64,23 @@ Porting Notes: Write Ahead Logging
>
> Open the kcaldav.db:
>
> - % doas sqlite3 caldav/kcaldav.db
> + $ doas sqlite3 caldav/kcaldav.db
>
> Type:
>
> - sqlite> PRAGMA journal_mode=WAL;
> + sqlite> PRAGMA journal_mode=WAL;
>
> To disable WAL later open the kcaldav db and type:
>
> - sqlite> PRAGMA journal_mode=DELETE;
> + sqlite> PRAGMA journal_mode=DELETE;
>
> If you plan to run kcaldav in a chroot environment you must
> create a /tmp directory in the chroot and it must be writable
> by the httpd daemon account:
>
> - % doas mkdir /var/www/tmp
> - % doas chown www:daemon /var/www/tmp
> - % doas chmod 755 /var/www/tmp
> + $ doas mkdir /var/www/tmp
> + $ doas chown www:daemon /var/www/tmp
> + $ doas chmod 755 /var/www/tmp
as above re prefix.
>
> For more details about WAL and temp directory requirements
> see:
>