Skip to content

Commit f637bbd

Browse files
philipskieraneglin
andauthored
[Docs] Add podman to README (#686)
* README: add podman Docker always has a tendency to get in my way on Debian. Also, I really like the userns setup for podman for giving permissions between host and container. * Ran linting on README --------- Co-authored-by: Kieran Eglin <[email protected]>
1 parent 7f56c0c commit f637bbd

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,23 @@ docker run \
129129
ghcr.io/kieraneglin/pinchflat:latest
130130
```
131131

132+
### Podman
133+
134+
The Podman setup is similar to Docker but changes a few flags to run under a User Namespace instead of root. To run Pinchflat under Podman and use the current user's UID/GID for file access run this:
135+
136+
```
137+
podman run \
138+
--security-opt label=disable \
139+
--userns=keep-id --user=$UID \
140+
-e TZ=America/Los_Angeles \
141+
-p 8945:8945 \
142+
-v /host/path/to/config:/config:rw \
143+
-v /host/path/to/downloads/:/downloads:rw \
144+
ghcr.io/kieraneglin/pinchflat:latest
145+
```
146+
147+
Using this setup consider creating a new `pinchflat` user and giving that user ownership to the config and download directory. See [Podman --userns](https://docs.podman.io/en/v4.6.1/markdown/options/userns.container.html) docs.
148+
132149
### IMPORTANT: File permissions
133150

134151
You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [#106](https://github.com/kieraneglin/pinchflat/issues/106) for more.

0 commit comments

Comments
 (0)