coreos-home-server/service
Alex Palaistras 80b3a5365e spectrum: Reduce logging level to warn
The default logging output for Spectrum is quite noisy, even at `info`
level, and so we're better served by setting to the more useful `warn`
level.
2022-05-04 12:22:22 +01:00
..
biboumi base: Only copy service directories if used 2022-02-05 16:05:00 +00:00
coturn coturn: Add reload target for systemd service 2022-04-09 18:28:39 +01:00
dovecot Add Grafana dashboards for Dovecot, Prosody 2022-04-28 23:07:51 +01:00
git base: Only copy service directories if used 2022-02-05 16:05:00 +00:00
grafana Implement metrics with Grafana and Prometheus 2022-04-25 20:12:06 +01:00
hugo hugo: Checkout correct branch when cloning 2022-04-23 13:35:02 +01:00
letsencrypt letsencrypt: Update lego to latest version 2022-04-23 13:35:22 +01:00
mariadb mariadb: Update to version 10.7 2022-04-23 13:35:37 +01:00
navidrome base: Only copy service directories if used 2022-02-05 16:05:00 +00:00
nginx nginx: Add default user to shared GID=10000 2022-05-04 11:29:53 +01:00
postfix Implement metrics with Grafana and Prometheus 2022-04-25 20:12:06 +01:00
prometheus dovecot: Use group_by, not fields for metric labels 2022-04-27 20:34:58 +01:00
prosody Improve reliability for prosody-component-register 2022-05-01 14:57:31 +01:00
radicale radicale: Update to version 3.1.5 2022-03-15 18:44:35 +00:00
rclone rclone: Update to version 1.58 2022-04-23 13:37:38 +01:00
redis base: Only copy service directories if used 2022-02-05 16:05:00 +00:00
rspamd rspamd: Update to version 3.2 2022-04-17 12:52:23 +01:00
rss2email base: Only copy service directories if used 2022-02-05 16:05:00 +00:00
spectrum spectrum: Reduce logging level to warn 2022-05-04 12:22:22 +01:00
writefreely base: Only copy service directories if used 2022-02-05 16:05:00 +00:00
README.md Flatten directory structures 2022-01-15 11:43:33 +00:00

CoreOS Service Configuration

This directory contains a set of common services available for deployment onto a CoreOS Home Server setup, and managed via systemd and Podman. Each service is given its own subdirectory, and each follows a set of common conventions in laying out its files.

Specifically, for a service example, we might find the following files and directories under the corresponding directory:

  • spec.bu -- This file is typically included by the host configuration, and is intended with installing any additional service files required for enabling the service.

  • Containerfile -- This file is used in building a container image, handled by the container-build@example service and presumably used in the systemd file for the example service.

  • example.env.template -- An optional file containing KEY=value definitions that can then be used in the systemd service. Host-wide environment is also available in this context, and can be used in expanding shared configuration, secrets, etc. This file is used by the container-environment@example service.

  • systemd/ -- This directory contains systemd configuration, to be copied into the host-wide /etc/systemd/system directory. You'll typically find things like example.service files which run the service under Podman, as well as potential one-off services which copy files around in pre-existing Podman containers.

  • container/ -- This directory contains any static files included in the Podman image, including templated configuration, scripts, etc.

  • service/ -- This (largely optional) directory contains files required by the systemd services themselves, and which are not included in the Podman images by default; examples include database migration files, one-off configuration files, etc.

Of all these files, the only ones whose paths are mandated by external services are the Containerfile and <name>.env.template files, neither of which are required by anything other than convention (i.e. you can choose not to build a container image via the systemd service).

Each service here might have additional details on how it's expected to be deployed and used, check the respective README.md files for more information.