Bot Updating Documentation

pull/272/head
LinuxServer-CI 2024-12-07 17:32:06 +00:00
rodzic 1ff7c4d1d3
commit e4449a48a8
Nie znaleziono w bazie danych klucza dla tego podpisu
1 zmienionych plików z 49 dodań i 44 usunięć

Wyświetl plik

@ -72,6 +72,9 @@ This image can be run with a read-only container filesystem. For details please
To help you get started creating a container from this image you can either use docker compose or the docker cli. To help you get started creating a container from this image you can either use docker compose or the docker cli.
>[!NOTE]
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml ```yaml
@ -196,27 +199,27 @@ Containers are configured using parameters passed at runtime (such as those abov
* Shell access whilst the container is running: * Shell access whilst the container is running:
```bash ```bash
docker exec -it socket-proxy /bin/sh docker exec -it socket-proxy /bin/sh
``` ```
* To monitor the logs of the container in realtime: * To monitor the logs of the container in realtime:
```bash ```bash
docker logs -f socket-proxy docker logs -f socket-proxy
``` ```
* Container version number: * Container version number:
```bash ```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' socket-proxy docker inspect -f '{{ index .Config.Labels "build_version" }}' socket-proxy
``` ```
* Image version number: * Image version number:
```bash ```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/socket-proxy:latest docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/socket-proxy:latest
``` ```
## Updating Info ## Updating Info
@ -227,66 +230,67 @@ Below are the instructions for updating containers:
### Via Docker Compose ### Via Docker Compose
* Update images: * Update images:
* All images: * All images:
```bash ```bash
docker compose pull docker compose pull
``` ```
* Single image: * Single image:
```bash ```bash
docker compose pull socket-proxy docker compose pull socket-proxy
``` ```
* Update containers: * Update containers:
* All containers: * All containers:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
* Single container: * Single container:
```bash ```bash
docker compose up -d socket-proxy docker compose up -d socket-proxy
``` ```
* You can also remove the old dangling images: * You can also remove the old dangling images:
```bash ```bash
docker image prune docker image prune
``` ```
### Via Docker Run ### Via Docker Run
* Update the image: * Update the image:
```bash ```bash
docker pull lscr.io/linuxserver/socket-proxy:latest docker pull lscr.io/linuxserver/socket-proxy:latest
``` ```
* Stop the running container: * Stop the running container:
```bash ```bash
docker stop socket-proxy docker stop socket-proxy
``` ```
* Delete the container: * Delete the container:
```bash ```bash
docker rm socket-proxy docker rm socket-proxy
``` ```
* You can also remove the old dangling images: * You can also remove the old dangling images:
```bash ```bash
docker image prune docker image prune
``` ```
### Image Update Notifications - Diun (Docker Image Update Notifier) ### Image Update Notifications - Diun (Docker Image Update Notifier)
**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. >[!TIP]
>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally ## Building locally
@ -311,6 +315,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions ## Versions
* **05.12.24:** - Rebase to Alpine 3.21.
* **26.08.24:** - Change `ALLOW_START`, `ALLOW_STOP`, and `ALLOW_RESTARTS` to work even with `POST=0`. * **26.08.24:** - Change `ALLOW_START`, `ALLOW_STOP`, and `ALLOW_RESTARTS` to work even with `POST=0`.
* **24.05.24:** - Rebase to Alpine 3.20. * **24.05.24:** - Rebase to Alpine 3.20.
* **15.04.24:** - Allow disabling IPv6 support for legacy devices. * **15.04.24:** - Allow disabling IPv6 support for legacy devices.