wip

README.md

@@ -17,18 +17,66 @@
 </h1>
 
 <p align="center">
-  swarmproxy docker image
+  Swarmproxy is a simple http/https proxy for outbound traffic in a docker swarm cluster.
 </p>
 
-<p align="center">
+## :book: About
-  <a href="https://drone.ocram85.com/OCram85/swarmproxy">
-    <img src="https://drone.ocram85.com/api/badges/OCram85/swarmproxy/status.svg" alt="Main Branch Build Status">
-  </a>
-</p>
 
-## :book: General
+## 🤖 Quickstart
 
-> :bulb: tbd...
+### 1. ⚡ Get the image 📦
+
+You can download the image from the gitea embedded container registry: `gitea.ocram85.com/ocram85/swarmproxy` with these tags:
+
+- `latest` - Is based on the lasted master branch commit.
+- `next` - Is a test build based on the pull request
+- `1`, `0.1`, `0.1.0` - tag based version.
+
+> **💡 NOTE: See the [packages page](https://gitea.ocram85.com/OCram85/-/packages/container/swarmproxy/latest) for latest version and all other available tags.**
+
+### 2.a Run as Docker Swarm Stack
+
+```yaml
+version: "3.8"
+
+secrets:
+  upstream-proxy:
+    external: true
+
+services:
+  swarmproxy:
+    image: gitea.ocram85.com/OCram85/swarmproxy:latest
+    environment:
+      # mandatory environment variables
+      - UPSTREAM_PROXY=
+      # Set UPSTREAM_PROXY as docker secret if your upstream needs authentication
+      # Eg.: http://user:password@upstream.intra:3128
+      #- UPSTREAM_PROXY_FILE=/run/secrets/UPSTREAM_PROXY
+
+      # optional settings
+      #- TINYPROXY_UID=5123
+      #- TINYPROXY_GID=5123
+      #- PORT=8888
+      #- TIMEOUT=600
+      #- LOGLEVEL=Info
+      #- MAXCLIENTS=600
+      #- FILTER_FILE=/ety/tinyproxy/filter
+    deploy:
+      replicas: 1
+    volumes:
+      # mount a single file into the container if you need the modify it afterwards
+      # You can reload the file with `kill -s USR1 $(pidof tinyproxy)`
+      - ./filter.txt:/etc/tinyproxy/filter:ro
+      # Use a docker config or volume in production
+      - 
+    networks:
+      - egress
+
+networks:
+  egress:
+   attachable: true
+   #external: true
+```
 
 ## 😡 We're Using GitHub Under Protest
 
@@ -36,7 +84,7 @@ This project is currently **mirrored** to GitHub. This is not ideal; GitHub is a
 proprietary, trade-secret system that is not Free and Open Source Software
 (FOSS). We are deeply concerned about using a proprietary system like GitHub
 to develop our FOSS project. We have an
-[open Gitea repository ](https://gitea.ocram85.com/CodeServer/arkanum/issues) where the
+[open Gitea repository ](https://gitea.ocram85.com/OCram85/swarmproxy/issues) where the
 project contributors are actively discussing how we can move away from GitHub
 in the long term. We urge you to read about the
 [Give up GitHub](https://GiveUpGitHub.org) campaign from
@@ -44,7 +92,7 @@ in the long term. We urge you to read about the
 some of the reasons why GitHub is not a good place to host FOSS projects.
 
 If you are a contributor who personally has already quit using GitHub, please
-[check this resource](https://gitea.ocram85.com/CodeServer/arkanum) for how to send us contributions without
+[check this resource](https://gitea.ocram85.com/OCram85/swarmproxy) for how to send us contributions without
 using GitHub directly.
 
 Any use of this project's code by GitHub Copilot, past or present, is done
@@ -66,8 +114,8 @@ swarmproxy is based on the following projects and wouldn't be possible without t
 ![AGPL](https://www.gnu.org/graphics/agplv3-155x51.png)
 
 ```
-Arkanum - Code-Server container optimized for daily use.
+Swarmproxy - A simple http/https proxy for outbound traffic in a docker swarm cluster.
-Copyright (C) 2022 "OCram85 <me@ocram85.com>"
+Copyright (C) 2023 "OCram85 <me@ocram85.com>"
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by