From eb4c3066f0232c9eb281d803167047a667ed29f9 Mon Sep 17 00:00:00 2001 From: Mad Scientist <67949699+madscientist16@users.noreply.github.com> Date: Thu, 24 Oct 2024 10:00:41 +0500 Subject: [PATCH] Update podman.md --- website/docs/community/podman.md | 64 +++----------------------------- 1 file changed, 5 insertions(+), 59 deletions(-) diff --git a/website/docs/community/podman.md b/website/docs/community/podman.md index 17a6cd08..3bb906c6 100644 --- a/website/docs/community/podman.md +++ b/website/docs/community/podman.md @@ -1,5 +1,4 @@ -# Run with Podman Quadlet files -Tested with podman version 5.2.4 +# Run with Podman ## Registries Container images are published on: @@ -21,51 +20,12 @@ This image provides various versions that are available via tags. -### podman - -``` -podman create \ - --name=komga \ - -p 25600:25600 \ - --mount type=bind,source=/path/to/config,target=/config \ - --mount type=bind,source=/path/to/data,target=/data \ - --restart unless-stopped \ - docker.io/gotson/komga:latest -``` - -Then start the container: - -``` -docker start komga -``` - ### podman quadlet +Tested with podman version 5.2.4 +Create the following podman quadlet files ``` ---- -version: '3.3' -services: - komga: - image: gotson/komga - container_name: komga - volumes: - - type: bind - source: /path/to/config - target: /config - - type: bind - source: /path/to/data - target: /data - - type: bind - source: /etc/timezone #alternatively you can use a TZ environment variable, like TZ=Europe/London - target: /etc/timezone - read_only: true - ports: - - 25600:25600 - user: "1000:1000" - # remove the whole environment section if you don't need it - environment: - - = - restart: unless-stopped +[Unit] ``` ## Parameters @@ -77,24 +37,10 @@ For example, `-p 8080:80` would expose port `80` from inside the container to be | Parameter | Function | |:---------------------------------------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------------| | `-p 25600:25600` | The port for the Komga APIs and web interface | -| `--user 1000:1000` | User:Group identifier - see below for explanation | | `--mount type=bind,source=/path/to/config,target=/config` | Database and Komga configurations | | `--mount type=bind,source=/path/to/data,target=/data` | Location of your data directory on disk. Choose a folder that contains both your books and your preferred import location for hardlinks to work. | | `-e ENV_VAR=value` | Any [configuration](/installation/configuration.md) environment variable | -## User / Group Identifiers - -When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user ID and group ID. - -Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. - -In this instance `UID=1000` and `GID=1000`, to find yours use `id ` as below: - -``` -$ id - uid=1000(jdoe) gid=1000(jdgroup) groups=1000(jdgroup) -``` - ## Increase memory limit By default the `java` process will be limited in the maximum amount of memory (RAM) it can use, usually 1gb. If you encounter some `OutOfMemoryException` in the logs you probably need to increase the maximum memory Komga can use. @@ -114,4 +60,4 @@ JAVA_TOOL_OPTIONS=-Xmx4g Below are the instructions for updating containers: -### +### Via podman auto-update