Skip to content

README.md

Latest commit

 

History

History
36 lines (30 loc) · 1.81 KB

README.md

File metadata and controls

36 lines (30 loc) · 1.81 KB

Podman Example

This directory contains an example of how to use a rootless Podman pod defined through Quadlets to run Grimmory.

Setup

  1. Copy the files in this directory to a suitable location on your system.
  • For many systems Quadlet monitors ~/.config/containers/systemd
    • mkdir -p ~/.config/containers/systemd && cp ./*grimmory* ~/.config/containers/systemd/
  1. Edit the grimmory.container to set the correct mounts for bookdrop and your library
  2. Create the Podman Secrets for the database 
    echo -n "YOUR PASSWORD" | podman secret create grimmory_db_pass -
  3. (Optional) podman pull ghcr.io/grimmory-tools/grimmory:v0.38.2 to pre-pull the image
  • If you have a slow connection, this is recommended because systemd will time out if the image pull takes too long.
  • To follow rolling releases instead, set the image tag to latest in grimmory.container.
  1. Run systemctl --user daemon-reload to pick up the new Quadlet unit.
  2. Start the pod with systemctl --user start grimmory-pod.service

Autoupdates

If automatic updates are desired, enable the systemd timer:

systemctl --user enable podman-auto-update.timer

This is a native way to schedule podman auto-update to run periodically and update/restart containers with AutoUpdate enabled in their Quadlet files.

Verification Commands

  • systemctl --user status grimmory-pod -l - Check the status of the pod
  • systemctl --user status grimmory-db -l - Check the status of the database
  • systemctl --user status grimmory -l - Check the status of the Grimmory container

Further Reading