coreos-home-server/service/redis/README.md
Alex Palaistras f877a72e83 Flatten directory structures
This commit contains a fairly large diff for a fairly small change:
moving the `config/common` directory to `host/base` to better reflect
its intended use, and promoting `config/service` to the root directory.

These changes unlock some improvements in `coreos-home-server-update`
processes, which will (assuming `/etc/coreos-home-server/base` exists)
keep host-wide systemd services in sync in addition to service-specific
ones.

Changes have been make to the `Makefile` and a few other places where
`config/common` was referenced, but most of this work is renames that
are not intended to break compatibility with new or running servers.
2022-01-15 11:43:33 +00:00

1.2 KiB

Redis

This directory contains a simple systemd service for running a disk-backed instance of Redis.

Deployment

Including the spec.bu file here in your host configuration is enough to have Redis enabled on the system -- no other configuration is needed. The following commands will manage the service accordingly:

  • Starting Redis: sudo systemctl start redis
  • Stopping Redis: sudo systemctl stop redis
  • Getting logs for the running service: journalctl -feu redis

By default, Redis listens on the internal network under the redis hostname, port 6379. Any services that wish to connect to Redis for that hostname and port need to also be included in the internal network.

By default, a named volume is created for redis which is used for restoring databases on service restart.

Use

Depending on Redis from other systemd services is as simple as declaring an ordered dependency in the systemd service file, for example:

[Unit]
Description=Service That Uses Redis
Wants=container-build@example.service redis.service
After=container-build@example.service redis.service

Redis will then be guaranteed to be running before the example service is.