Add install script and end-user docs #83

Merged
miro merged 2 commits from install-script into main 2026-10-12 16:37:05 +00:00
Owner
  • install/: install.sh, docker-compose.yml, Caddyfile and .env.example for a self-hosted setup with Pocket ID, Caddy, Files and rclone. The script checks for Docker, writes a .env with generated secrets and starts Pocket ID and Caddy.
  • Release workflow attaches those four files to each release, so releases/latest/download/install.sh | bash installs a matching set.
  • Docs: end-user getting started, authentication details, new frontpage feature blocks; README points to the docs.
- `install/`: `install.sh`, `docker-compose.yml`, `Caddyfile` and `.env.example` for a self-hosted setup with Pocket ID, Caddy, Files and rclone. The script checks for Docker, writes a `.env` with generated secrets and starts Pocket ID and Caddy. - Release workflow attaches those four files to each release, so `releases/latest/download/install.sh | bash` installs a matching set. - Docs: end-user getting started, authentication details, new frontpage feature blocks; README points to the docs.
Add end-user install script and release assets, expand docs
Some checks failed
CI / lint (pull_request) Successful in 31s
CI / format (pull_request) Failing after 34s
CI / typecheck (pull_request) Successful in 42s
CI / test (pull_request) Successful in 43s
CI / knip (pull_request) Successful in 45s
CI / docker (arm64, docker-arm64) (pull_request) Successful in 16s
CI / build (pull_request) Successful in 43s
CI / docker (amd64, docker-amd64) (pull_request) Successful in 48s
CI / manifest (pull_request) Has been skipped
CI / deploy-test (pull_request) Has been skipped
E2E / playwright (pull_request) Successful in 1m35s
b74f69aaf1
Format create-release script
All checks were successful
CI / test (pull_request) Successful in 23s
CI / format (pull_request) Successful in 32s
CI / docker (amd64, docker-amd64) (pull_request) Successful in 4s
CI / knip (pull_request) Successful in 42s
CI / lint (pull_request) Successful in 43s
CI / typecheck (pull_request) Successful in 45s
CI / docker (arm64, docker-arm64) (pull_request) Successful in 5s
CI / manifest (pull_request) Has been skipped
CI / deploy-test (pull_request) Has been skipped
CI / build (pull_request) Successful in 32s
E2E / playwright (pull_request) Successful in 2m9s
1c027cbb44
miro merged commit e27e2c5976 into main 2026-10-12 16:37:05 +00:00
miro deleted branch install-script 2026-10-12 16:37:05 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
miro/files!83
No description provided.