Skip to content

Commit ba8979d

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 19bcac7 commit ba8979d

1 file changed

Lines changed: 95 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,24 @@ The container should be run on the same docker network as the service(s) using i
6262
* To see the versions of the API your Docker daemon and client support, use `docker version` and check the `API version`.
6363
* [Read the docs](https://docs.docker.com/engine/api/) for the API version you are using for an explanation of all the available endpoints.
6464

65+
### Podman / libpod API
66+
67+
Podman exposes two API groups on the same socket: the Docker-compatible API (controlled by the existing env vars above) and the libpod-native API prefixed with `/libpod/`. The `LIBPOD_*` environment variables control access to the libpod endpoints independently of their Docker-compat equivalents.
68+
69+
For example, to use [prometheus-podman-exporter](https://github.com/containers/prometheus-podman-exporter), enable:
70+
71+
```yaml
72+
- LIBPOD_CONTAINERS=1
73+
- LIBPOD_INFO=1
74+
- LIBPOD_NETWORKS=1
75+
- LIBPOD_PODS=1
76+
- LIBPOD_VOLUMES=1
77+
- LIBPOD_IMAGES=1
78+
- LIBPOD_EVENTS=1
79+
```
80+
81+
Point the exporter at `tcp://socket-proxy:2375` using `CONTAINER_HOST`. `LIBPOD_PING` and `LIBPOD_VERSION` are enabled by default (like their Docker-compat counterparts `PING` and `VERSION`).
82+
6583
## Read-Only Operation
6684

6785
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
@@ -113,6 +131,31 @@ services:
113131
- TZ=Etc/UTC #optional
114132
- VERSION=1 #optional
115133
- VOLUMES=0 #optional
134+
- LIBPOD_ALLOW_PAUSE=0 #optional
135+
- LIBPOD_ALLOW_POD_PAUSE=0 #optional
136+
- LIBPOD_ALLOW_POD_RESTARTS=0 #optional
137+
- LIBPOD_ALLOW_POD_START=0 #optional
138+
- LIBPOD_ALLOW_POD_STOP=0 #optional
139+
- LIBPOD_ALLOW_POD_UNPAUSE=0 #optional
140+
- LIBPOD_ALLOW_RESTARTS=0 #optional
141+
- LIBPOD_ALLOW_START=0 #optional
142+
- LIBPOD_ALLOW_STOP=0 #optional
143+
- LIBPOD_ALLOW_UNPAUSE=0 #optional
144+
- LIBPOD_CONTAINERS=0 #optional
145+
- LIBPOD_EVENTS=0 #optional
146+
- LIBPOD_EXEC=0 #optional
147+
- LIBPOD_GENERATE=0 #optional
148+
- LIBPOD_IMAGES=0 #optional
149+
- LIBPOD_INFO=0 #optional
150+
- LIBPOD_MANIFESTS=0 #optional
151+
- LIBPOD_NETWORKS=0 #optional
152+
- LIBPOD_PING=1 #optional
153+
- LIBPOD_PLAY=0 #optional
154+
- LIBPOD_PODS=0 #optional
155+
- LIBPOD_SECRETS=0 #optional
156+
- LIBPOD_SYSTEM=0 #optional
157+
- LIBPOD_VERSION=1 #optional
158+
- LIBPOD_VOLUMES=0 #optional
116159
volumes:
117160
- /var/run/docker.sock:/var/run/docker.sock:ro
118161
restart: unless-stopped
@@ -157,6 +200,31 @@ docker run -d \
157200
-e TZ=Etc/UTC `#optional` \
158201
-e VERSION=1 `#optional` \
159202
-e VOLUMES=0 `#optional` \
203+
-e LIBPOD_ALLOW_PAUSE=0 `#optional` \
204+
-e LIBPOD_ALLOW_POD_PAUSE=0 `#optional` \
205+
-e LIBPOD_ALLOW_POD_RESTARTS=0 `#optional` \
206+
-e LIBPOD_ALLOW_POD_START=0 `#optional` \
207+
-e LIBPOD_ALLOW_POD_STOP=0 `#optional` \
208+
-e LIBPOD_ALLOW_POD_UNPAUSE=0 `#optional` \
209+
-e LIBPOD_ALLOW_RESTARTS=0 `#optional` \
210+
-e LIBPOD_ALLOW_START=0 `#optional` \
211+
-e LIBPOD_ALLOW_STOP=0 `#optional` \
212+
-e LIBPOD_ALLOW_UNPAUSE=0 `#optional` \
213+
-e LIBPOD_CONTAINERS=0 `#optional` \
214+
-e LIBPOD_EVENTS=0 `#optional` \
215+
-e LIBPOD_EXEC=0 `#optional` \
216+
-e LIBPOD_GENERATE=0 `#optional` \
217+
-e LIBPOD_IMAGES=0 `#optional` \
218+
-e LIBPOD_INFO=0 `#optional` \
219+
-e LIBPOD_MANIFESTS=0 `#optional` \
220+
-e LIBPOD_NETWORKS=0 `#optional` \
221+
-e LIBPOD_PING=1 `#optional` \
222+
-e LIBPOD_PLAY=0 `#optional` \
223+
-e LIBPOD_PODS=0 `#optional` \
224+
-e LIBPOD_SECRETS=0 `#optional` \
225+
-e LIBPOD_SYSTEM=0 `#optional` \
226+
-e LIBPOD_VERSION=1 `#optional` \
227+
-e LIBPOD_VOLUMES=0 `#optional` \
160228
-v /var/run/docker.sock:/var/run/docker.sock:ro \
161229
--restart unless-stopped \
162230
--read-only \
@@ -201,6 +269,32 @@ Containers are configured using parameters passed at runtime (such as those abov
201269
| `-e TZ=Etc/UTC` | `Set container timezone` |
202270
| `-e VERSION=1` | `/version` |
203271
| `-e VOLUMES=0` | `/volumes` |
272+
| **Podman libpod API** | |
273+
| `-e LIBPOD_ALLOW_START=0` | `/libpod/containers/{id}/start` - **This option will work even if `POST=0`** |
274+
| `-e LIBPOD_ALLOW_STOP=0` | `/libpod/containers/{id}/stop` - **This option will work even if `POST=0`** |
275+
| `-e LIBPOD_ALLOW_RESTARTS=0` | `/libpod/containers/{id}/stop`, `/libpod/containers/{id}/restart`, and `/libpod/containers/{id}/kill` - **This option will work even if `POST=0`** |
276+
| `-e LIBPOD_ALLOW_PAUSE=0` | `/libpod/containers/{id}/pause` - **This option will work even if `POST=0`** |
277+
| `-e LIBPOD_ALLOW_UNPAUSE=0` | `/libpod/containers/{id}/unpause` - **This option will work even if `POST=0`** |
278+
| `-e LIBPOD_ALLOW_POD_START=0` | `/libpod/pods/{name}/start` - **This option will work even if `POST=0`** |
279+
| `-e LIBPOD_ALLOW_POD_STOP=0` | `/libpod/pods/{name}/stop` - **This option will work even if `POST=0`** |
280+
| `-e LIBPOD_ALLOW_POD_RESTARTS=0` | `/libpod/pods/{name}/stop`, `/libpod/pods/{name}/restart`, and `/libpod/pods/{name}/kill` - **This option will work even if `POST=0`** |
281+
| `-e LIBPOD_ALLOW_POD_PAUSE=0` | `/libpod/pods/{name}/pause` - **This option will work even if `POST=0`** |
282+
| `-e LIBPOD_ALLOW_POD_UNPAUSE=0` | `/libpod/pods/{name}/unpause` - **This option will work even if `POST=0`** |
283+
| `-e LIBPOD_CONTAINERS=0` | `/libpod/containers` |
284+
| `-e LIBPOD_EVENTS=0` | `/libpod/events` |
285+
| `-e LIBPOD_EXEC=0` | `/libpod/exec` |
286+
| `-e LIBPOD_GENERATE=0` | `/libpod/generate` (systemd/kube YAML generation) |
287+
| `-e LIBPOD_IMAGES=0` | `/libpod/images` |
288+
| `-e LIBPOD_INFO=0` | `/libpod/info` |
289+
| `-e LIBPOD_MANIFESTS=0` | `/libpod/manifests` |
290+
| `-e LIBPOD_NETWORKS=0` | `/libpod/networks` |
291+
| `-e LIBPOD_PING=1` | `/libpod/_ping` |
292+
| `-e LIBPOD_PLAY=0` | `/libpod/play` (kube play) |
293+
| `-e LIBPOD_PODS=0` | `/libpod/pods` (Podman-specific pod management) |
294+
| `-e LIBPOD_SECRETS=0` | `/libpod/secrets` |
295+
| `-e LIBPOD_SYSTEM=0` | `/libpod/system` |
296+
| `-e LIBPOD_VERSION=1` | `/libpod/version` |
297+
| `-e LIBPOD_VOLUMES=0` | `/libpod/volumes` |
204298
| `-v /var/run/docker.sock:ro` | Mount the host docker socket into the container. |
205299
| `--read-only` | Make the container filesystem read-only. |
206300
| `--tmpfs /run` | Mount /run to tmpfs (RAM) to make it writeable. |
@@ -325,6 +419,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
325419

326420
## Versions
327421

422+
* **13.06.26:** - Add libpod API support for Podman via `LIBPOD_*` environment variables.
328423
* **24.02.26:** - Add `ALLOW_PAUSE` and `ALLOW_UNPAUSE`.
329424
* **26.12.25:** - Rebase to Alpine 3.23.
330425
* **19.08.25:** - Add tzdata for localised logging timestamps.

0 commit comments

Comments
 (0)