summaryrefslogtreecommitdiff
path: root/docs/quick-start.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-05-17 15:25:52 +0300
committerPaul Buetow <paul@buetow.org>2026-05-17 15:25:52 +0300
commit914bd7cd6aa14e839332a98d91c30b19865b0cf2 (patch)
tree02b11537237a204048589e14ed24938b805e42f7 /docs/quick-start.md
parent3b24f0e1be832584d6550e8cc3e5d24329f66f90 (diff)
Restructure repo: move Go server into player-server/
Diffstat (limited to 'docs/quick-start.md')
-rw-r--r--docs/quick-start.md56
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/quick-start.md b/docs/quick-start.md
deleted file mode 100644
index d38304d..0000000
--- a/docs/quick-start.md
+++ /dev/null
@@ -1,56 +0,0 @@
-Quick Start
-===========
-
-### Running from source
-
-```bash
-go build -o player ./cmd/player
-./player
-```
-
-Open `http://localhost:8080` — on first visit you'll be redirected to the bootstrap page to create an admin account.
-
-### Running with Docker
-
-```bash
-docker build -t player:latest .
-docker run -p 8080:8080 \
- -v player-data:/data \
- -v /path/to/media:/media \
- -e MEDIA_ROOT=/media \
- -e DB_PATH=/data/media.db \
- player:latest
-```
-
-### Deploying to Kubernetes
-
-```bash
-kubectl apply -f k8s/
-```
-
-This creates a Deployment (non-root, probes included), ClusterIP Service, PVCs for `/data` and `/media`, and an optional Secret.
-
-The `Deployment` overrides two settings for K8s:
-- `DB_PATH=/data/media.db`
-- `MEDIA_ROOT=/media`
-
-Probes:
-- **Liveness:** `GET /healthz` (no DB dependency)
-- **Readiness:** `GET /readyz` (DB ping)
-
-Security:
-- `runAsNonRoot: true`
-- `runAsUser: 65534` / `runAsGroup: 65534`
-- `allowPrivilegeEscalation: false`
-- `readOnlyRootFilesystem: true`
-
-### Mage targets
-
-| Target | Description |
-|--------|-------------|
-| `mage build` | Compile the binary |
-| `mage test` | Run `go test ./...` |
-| `mage install` | Build and copy binary to `$GOPATH/bin` |
-| `mage clean` | Remove build artifacts |
-| `mage docker-build` | Build Docker image as `player:latest` |
-| `mage docker-push` | Push `player:latest` to registry | \ No newline at end of file