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`).
|
||||
* 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
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user