Skip to content

Commit c610689

Browse files
committed
update documentation
1 parent eb2512a commit c610689

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ It is designed with security in mind, so there are secure defaults and an additi
1111

1212
The allowlist is configured for each HTTP method separately using the Go regexp syntax, allowing fine-grained control over the allowed HTTP methods.
1313

14-
The source code is available on [GitHub: wollomatic/socket-proxy](https://github.com/wollomatic/socket-proxy).
14+
The source code is available on [GitHub: wollomatic/socket-proxy](https://github.com/wollomatic/socket-proxy)
15+
16+
> [!NOTE]
17+
> Starting with version 1.6.0, the socket-proxy container image is also available on GHCR.
1518
1619
## Getting Started
1720

@@ -23,14 +26,17 @@ You should know what you are doing. Never expose socket-proxy to a public networ
2326

2427
### Installing
2528

26-
The container image is available on [Docker Hub: wollomatic/socket-proxy](https://hub.docker.com/r/wollomatic/socket-proxy).
29+
The container image is available on [Docker Hub (wollomatic/socket-proxy)](https://hub.docker.com/r/wollomatic/socket-proxy)
30+
and on the [GitHub Container Registry (ghcr.io/wollomatic/socket-proxy)](https://hub.docker.com/r/wollomatic/socket-proxy).
31+
2732

28-
To pin one specific version, use the version tag (for example, `wollomatic/socket-proxy:1.0.1`).
29-
To always use the most recent version, use the `1` tag (`wollomatic/socket-proxy:1`). This tag will be valid as long as there is no breaking change in the deployment.
33+
To pin one specific version, use the version tag (for example, `wollomatic/socket-proxy:1.6.0` or `ghcr.io/wollomatic/socket-proxy:1.6.0`).
34+
To always use the most recent version, use the `1` tag (`wollomatic/socket-proxy:1` or `ghcr.io/wollomatic/socket-proxy:1`). This tag will be valid as long as there is no breaking change in the deployment.
3035

3136
There may be an additional docker image with the `testing`-tag. This image is only for testing. Likely, documentation for the `testing` image could only be found in the GitHub commit messages. It is not recommended to use the `testing` image in production.
3237

3338
Every socket-proxy release image is signed with Cosign. The public key is available on [GitHub: wollomatic/socket-proxy/main/cosign.pub](https://raw.githubusercontent.com/wollomatic/socket-proxy/main/cosign.pub) and [https://wollomatic.de/socket-proxy/cosign.pub](https://wollomatic.de/socket-proxy/cosign.pub). For more information, please refer to the [Security Policy](https://github.com/wollomatic/socket-proxy/blob/main/SECURITY.md).
39+
As of version 1.6, all multi-arch images are signed.
3440

3541
### Allowing access
3642

@@ -44,9 +50,6 @@ Socket-proxy listens per default only on `127.0.0.1`. Depending on what you need
4450

4551
#### Using a unix socket instead of a TCP listener
4652

47-
> [!CAUTION]
48-
> This is a new feature introduced in version 1.5.0. If you experience any issues, please feel free to open an GitHub issue.
49-
5053
If you want to proxy/filter the unix socket to a new unix socket instead to a TCP listener,
5154
you need to set the `-proxysocketendpoint` parameter or the `SP_PROXYSOCKETENDPOINT` env variable to the socket path of the new unix socket.
5255
This will also disable the TCP listener.
@@ -202,6 +205,8 @@ socket-proxy can be configured via command line parameters or via environment va
202205

203206
1.5 - allow unix socket as proxied/filtered endpoint
204207

208+
1.6 - Cosign: sign a multi-arch container image AND all referenced, discrete images. Image is also available on GHCR.
209+
205210
## License
206211

207212
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)