docs(readme): document registry pull workflow and image publish script

This commit is contained in:
Rafał Tyński
2026-10-03 21:16:20 +02:00
parent 9d28d23e45
commit 179ad953cb
+37 -5
View File
@@ -14,6 +14,11 @@ Platforma Małopolskiego Hubu Innowacji Społecznych (MVP hackathonu).
- .NET SDK 10+
- Node.js 22+ (npm)
- PowerShell Core 7+ (`pwsh`) — wymagany do uruchomienia `scripts/*.ps1`.
Windows nie kojarzy domyślnie plików `.ps1`, dlatego skrypty uruchamiaj przez
`pwsh` (np. `pwsh ./scripts/docker-push.ps1`), a nie przez dwuklik / samo
`./scripts/docker-push.ps1`. Instalacja: https://aka.ms/powershell
## Praca lokalna
@@ -39,19 +44,46 @@ node scripts/build.mjs # buduje całość (client + copy + backend)
## Docker
Szablon pobiera gotowy obraz z rejestru Gitea (pełna ścieżka), bez lokalnego
buildowania:
```pwsh
cp docker-compose.yaml.example docker-compose.yaml
docker compose up --build
docker compose pull
docker compose up -d
```
- Aplikacja: http://localhost:8080
- Aplikacja: http://localhost:8075
- Dane: `./data` (bind mount, trwałe — SurrealDB embedded RocksDB)
- Obraz: `tarninahub:0.0.1`
- Obraz: `git.rtynski.pl/rtynski/hy2026:latest`
Wolumen hosta można wskazać zmienną `TARNINAHUB_PORT` (domyślnie `8080`).
Plik `docker-compose.yaml.example` jest szablonem; `docker-compose.yaml` możesz
Port hosta można wskazać zmienną `TARNINAHUB_PORT` (domyślnie `8075`), a wersję
obrazu zmienną `APP_VERSION` (domyślnie `latest`). Plik
`docker-compose.yaml.example` jest szablonem; `docker-compose.yaml` możesz
dostosować lokalnie.
### Publikacja obrazu do Gitea
Token dostępu utworzysz w Gitea:
- https://git.rtynski.pl/user/settings/applications
- **Generate New Token** → zakres **`write:package`** (wystarcza do pushu obrazu).
Wymagany **PowerShell Core 7+** (`pwsh`). Windows nie uruchamia domyślnie
plików `.ps1`, więc skrypt wywołaj jawnie przez `pwsh`:
```pwsh
$env:GITEA_USER = "rtynski"; $env:GITEA_TOKEN = "<token>"
pwsh ./scripts/docker-push.ps1
```
Skrypt najpierw sprawdza połączenie z demonem Docker i rejestrem, czyta wersję z
`backend/TarninaHub.csproj`. Jeśli dana wersja jest już wypchnięta do rejestru,
kończy pracę z czerwonym komunikatem; w przeciwnym razie buduje frontend,
kopiuje go do `backend/wwwroot`, buduje backend, buduje obraz Docker i wypycha go
do `git.rtynski.pl/rtynski/hy2026` jako `<wersja>` oraz `latest`. Nadpisanie
sprawdzenia: `-Force`.
## Struktura
```