reorganising, added docker-compose.traefik.yml, split README
This commit is contained in:
48
README.md
48
README.md
@@ -4,52 +4,16 @@ _a web based password generator_
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
# 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`).
|
* generates long and random, secure passwords (read about the [security considerations](SECURITY.md))
|
||||||
* Zwischenablage: Mit dem Button "In Zwischenablage kopieren" wird das Passwort in die Zwischenablage kopiert.
|
* copy to clipboard
|
||||||
* Docker: Der Container enthält nur die Go-Anwendung und keine zusätzliche Linux-Distribution.
|
* very small docker container, that only contains the application and has minimum attack surface
|
||||||
|
|
||||||
|
## Usage
|
||||||
# Baue die Go-Anwendung
|
|
||||||
|
|
||||||
```
|
```
|
||||||
go build -o password-generator ./
|
git clone https://gitea.scu.si/FlorianWalther/Web-Password.git
|
||||||
```
|
|
||||||
|
|
||||||
# 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
|
docker compose pull
|
||||||
```
|
|
||||||
|
|
||||||
### start up
|
|
||||||
|
|
||||||
```
|
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
### bring down
|
|
||||||
|
|
||||||
```
|
|
||||||
docker compose down
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
45
misc/MoreUsage.md
Normal file
45
misc/MoreUsage.md
Normal file
@@ -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
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
24
misc/docker-compose.traefik.yml
Normal file
24
misc/docker-compose.traefik.yml
Normal file
@@ -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
|
||||||
|
|
||||||
Reference in New Issue
Block a user