docs: verlinkungen angepasst und docs aufgeräumt
This commit is contained in:
31
README.md
31
README.md
@@ -3,10 +3,6 @@
|
||||
Inoffizielles Docker-Image für [Open-Typer](https://github.com/Open-Typer/Open-Typer) –
|
||||
ein freier und quelloffener Tipp-Trainer, der als **WebAssembly direkt im Browser** läuft.
|
||||
|
||||
> **Hinweis:** Dies ist kein offizielles Projekt der Open-Typer-Entwickler.
|
||||
> Der Quellcode von Open-Typer ist unter der [GPL v3](https://github.com/Open-Typer/Open-Typer/blob/master/LICENSE)
|
||||
> lizenziert. Dieses Repository steht ebenfalls unter der GPL v3.
|
||||
|
||||
---
|
||||
|
||||
## Schnellstart
|
||||
@@ -37,7 +33,7 @@ PORT=3000 docker compose up -d
|
||||
docker compose up --build -d
|
||||
```
|
||||
|
||||
> **Hinweis:** Der Build dauert **30–60 Minuten**, da Qt 6.5.2 und Emscripten 3.1.25
|
||||
> **Hinweis:** Der Build dauert **10–15 Minuten**, da Qt 6.5.2 und Emscripten 3.1.25
|
||||
> komplett im Container kompiliert werden.
|
||||
|
||||
---
|
||||
@@ -64,30 +60,10 @@ Das finale Image ist unter **50 MB** klein.
|
||||
|
||||
---
|
||||
|
||||
## Automatischer Build (Gitea Actions)
|
||||
|
||||
### Benötigte Variablen & Secrets
|
||||
|
||||
Folgende Werte müssen in den **Gitea Repository-Einstellungen** hinterlegt werden
|
||||
(*Settings → Actions → Variables / Secrets*):
|
||||
|
||||
| Typ | Name | Wert |
|
||||
|---|---|---|
|
||||
| Variable | `REGISTRY_URL` | `https://git.techniverse.net` |
|
||||
| Secret | `REGISTRY_USER` | `scriptos` |
|
||||
| Secret | `REGISTRY_TOKEN` | Gitea Access Token mit `package:write`-Berechtigung |
|
||||
|
||||
Ein neues Release in Gitea (z.B. Tag `v1.0.0`) startet den Build automatisch.
|
||||
|
||||
---
|
||||
|
||||
Das Image wird automatisch gebaut und in die
|
||||
[Gitea Container Registry](https://git.techniverse.net/scriptos/-/packages)
|
||||
[Gitea Container Registry](https://git.techniverse.net/scriptos/-/packages/container/open-typer-wasm/latest)
|
||||
veröffentlicht, sobald ein neues Release auf
|
||||
[git.techniverse.net](https://git.techniverse.net/scriptos/open-typer-wasm) erstellt wird.
|
||||
|
||||
Ein manueller Build kann jederzeit über die
|
||||
[Actions-Seite](https://git.techniverse.net/scriptos/open-typer-wasm/actions) ausgelöst werden.
|
||||
[git.techniverse.net](https://git.techniverse.net/scriptos/open-typer-docker) erstellt wird.
|
||||
|
||||
---
|
||||
|
||||
@@ -113,4 +89,3 @@ unter der GPL v3: https://github.com/Open-Typer/Open-Typer
|
||||
|
||||
- [Open-Typer Quellcode](https://github.com/Open-Typer/Open-Typer)
|
||||
- [Open-Typer Dokumentation](https://open-typer.github.io/)
|
||||
- [Gitea Container Registry](https://git.techniverse.net/scriptos/-/packages/container/open-typer-wasm)
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
services:
|
||||
open-typer:
|
||||
# Verwende das vorgebaute Image von Docker Hub (empfohlen)
|
||||
# oder baue lokal mit: docker compose up --build
|
||||
image: ${DOCKER_IMAGE:-git.techniverse.net/scriptos/open-typer-wasm:latest}
|
||||
image: git.techniverse.net/scriptos/open-typer-wasm:latest
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
@@ -21,7 +19,7 @@ services:
|
||||
start_period: 10s
|
||||
labels:
|
||||
- "com.open-typer.description=Open-Typer WebAssembly – kostenloser Open-Source Tipp-Trainer"
|
||||
- "com.open-typer.source=https://git.techniverse.net/scriptos/open-typer-wasm"
|
||||
- "com.open-typer.source=https://git.techniverse.net/scriptos/open-typer-docker"
|
||||
|
||||
networks:
|
||||
opentyper_net:
|
||||
|
||||
Reference in New Issue
Block a user