diff --git a/README.md b/README.md index c8d8592..7835a9e 100644 --- a/README.md +++ b/README.md @@ -4,52 +4,16 @@ _a web based password generator_ ![App Screenshot](img/screenshot.png) -# Funktionsweise +## Features -* Passwortgenerierung: Die Anwendung generiert ein 32-stelliges Passwort mit Großbuchstaben, Kleinbuchstaben und Ziffern (entspricht dem Befehl `apg -a 1 -m 32 -n 1 -M NCL`). -* Zwischenablage: Mit dem Button "In Zwischenablage kopieren" wird das Passwort in die Zwischenablage kopiert. -* Docker: Der Container enthält nur die Go-Anwendung und keine zusätzliche Linux-Distribution. +* generates long and random, secure passwords (read about the [security considerations](SECURITY.md)) +* copy to clipboard +* very small docker container, that only contains the application and has minimum attack surface - -# Baue die Go-Anwendung +## Usage ``` -go build -o password-generator ./ -``` - -# Baue das Docker-Image - -``` -docker build -t password-generator . -``` - -# Starte den Docker Container - -``` -docker run -p 8080:8080 password-generator -``` - -## mit docker-compose - -Ein `docker-compose.yml` wird mitgeliefert. - -### initial pull - -``` -docker compose login gitea.scu.si +git clone https://gitea.scu.si/FlorianWalther/Web-Password.git docker compose pull -``` - -### start up - -``` docker compose up -d ``` - -### bring down - -``` -docker compose down -``` - - diff --git a/misc/MoreUsage.md b/misc/MoreUsage.md new file mode 100644 index 0000000..b61e3da --- /dev/null +++ b/misc/MoreUsage.md @@ -0,0 +1,45 @@ + + +# Baue die Go-Anwendung + +``` +go build -o password-generator ./ +``` + +# Baue das Docker-Image + +``` +docker build -t password-generator . +``` + +# Starte den Docker Container + +``` +docker run -p 8080:8080 password-generator +``` + +## mit docker-compose + +Ein `docker-compose.yml` wird mitgeliefert. + +### initial pull + +``` +docker compose login gitea.scu.si +docker compose pull +``` + +### start up + +``` +docker compose up -d +``` + +### bring down + +``` +docker compose down +``` + + + diff --git a/misc/docker-compose.traefik.yml b/misc/docker-compose.traefik.yml new file mode 100644 index 0000000..9ffd3c5 --- /dev/null +++ b/misc/docker-compose.traefik.yml @@ -0,0 +1,24 @@ +services: + password-generator: + image: gitea.scu.si/florianwalther/password-generator:latest + container_name: password-generator + restart: always + expose: + - "8080:8080" + # Falls die Registry privat ist, muss der Host zuvor mit + # 'docker login gitea.scu.si' angemeldet worden sein. + labels: + - "traefik.enable=true" + - "traefik.docker.network=traefik_backend" + - "traefik.http.routers.webpass.rule=Host(`passwd.scu.si`)" + - "traefik.http.routers.webpass.entrypoints=web,websecure" + - "traefik.http.routers.webpass.tls=true" + - "traefik.http.routers.webpass.tls.certresolver=myresolver" + - "traefik.http.services.webpass.loadbalancer.server.port=8080" + networks: + - traefik_backend + +networks: + traefik_backend: + external: true + diff --git a/docker-compose.yml b/misc/docker-compose.yml similarity index 100% rename from docker-compose.yml rename to misc/docker-compose.yml