Skip to content

Commit

Permalink
slightly improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
wollomatic committed Oct 10, 2023
1 parent 173df3f commit b12bb75
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ It is designed with security in mind, so there are secure defaults, and there is

Configuration of the allowlist is done for each http method separately using the Go regexp syntax. This allows fine-grained control over the allowed http methods.

The source code is available on [GitHub: wollomatic/socket-proxy](https://github.com/wollomatic/socket-proxy).

## Getting Started

### Warning
Expand All @@ -19,6 +21,8 @@ You should know what you are doing. Accidentally exposing a Unix socket to the p

The container image is available on [Docker Hub: wollomatic/socket-proxy](https://hub.docker.com/r/wollomatic/socket-proxy).

Every socket-proxy 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). Please refer to the [Security Policy](https://github.com/wollomatic/socket-proxy/blob/main/SECURITY.md) for more information.

### Allowing access

Because of the secure-by-default design, you need to explicitly allow every access.
Expand Down

0 comments on commit b12bb75

Please sign in to comment.