prepare release

This commit is contained in:
OCram85 2023-07-12 16:14:56 +02:00
parent 09b9bcb3ea
commit e6f31060c7
2 changed files with 31 additions and 6 deletions

View File

@ -1,8 +1,11 @@
Gitea
LOGLEVEL
MAXCLIENTS
Quickstart
swarmproxy
Swarmproxy
tbd
Tinyproxy
TINYPROXY
UID
USR

View File

@ -7,15 +7,11 @@
<a href="https://gitea.ocram85.com/OCram85/swarmproxy/">
<img
src="/OCram85/swarmproxy/raw/branch/main/assets/social-logo.png"
alt="Swarmproxy"
alt="Swarmproxy - Tame your traffic"
>
</a>
</p>
<h1 align="center">
Swarmproxy - Tame your traffic
</h1>
<p align="center">
Swarmproxy is a simple http proxy to limit your outbound traffic.
</p>
@ -24,7 +20,31 @@
## 🤖 Quickstart
## 🦁 FAQ
### What ist 🦁 Swarmproxy?
Swarmproxy is a simply way to integrate a http proxy in your Docker swarm cluster or any other container network.
It acts as an centralized proxy to limit your outbound / egress traffic. You can also enable a whitelist filter to
limit the allowed domains. There is also an option to use a upstream proxy.
### What does 🦁 Swarmproxy for you?
Enterprise and production environments often face more stringent security requirements.
Therefore, unfiltered Internet access may be prohibited.
So Swarmproxy could help you with these features:
- Direct web access from Container workload prevented.
- Optional upstream proxy with or without authentication
- Optional domain based whitelist filter.
### What does 🦁 Swarmproxy not?
Swarmproxy is just a supercharged Tinyproxy where you can point your container workload to.
> ☣️ Swarmproxy does not block the web access or other traffic if the proxy is not used. It's not a firewall, and it
> does not customize your iptables or so
### 1. ⚡ Get the image 📦
@ -57,6 +77,7 @@ networks:
services:
swarmproxy:
# Do not use the `latest` tag in production!
image: gitea.ocram85.com/OCram85/swarmproxy:latest
deploy:
replicas: 1
@ -93,6 +114,7 @@ services:
```
## 💣 Known Issues
## 😡 We're Using GitHub Under Protest