Skip to content

shahboura/selfhost-compose-wizard

Repository files navigation

Selfhost Compose Wizard

Validation Live Site License: MIT

Lighthouse Performance Lighthouse Accessibility Lighthouse Best Practices

Privacy-first web wizard for generating docker-compose.yaml and .env files for self-hosted services.

What it does

  • Guided service selection and environment variable setup
  • Service-specific defaults, references, and risk warnings
  • In-form secure secret generation for supported fields
  • In-browser generation (no server-side form processing)
  • Bundle export: docker-compose.yaml + .env (missing required values exported as explicit placeholders)

Supported services

Service Category Variant
Audiobookshelf media base
BentoPDF documents base
BentoPDF documents oauth2-proxy
Dozzle operations base
Dozzle operations oauth2-proxy
Immich media base
IT Tools developer-tools base
Jellyfin media base
GetArcane operations base
GetArcane + OIDC operations oidc
Plex media base
Watchtower operations base

Tech stack

  • React 19 + TypeScript
  • Vite 8
  • ESLint
  • Vitest (unit tests)
  • Playwright (E2E)

Run locally

npm install
npm run dev

Run with Docker

docker compose -f docker-compose.app.yml up --build

App URL: http://localhost:8080

Validation

npm run test:all

test:all runs lint, unit tests (Vitest), template validation, link validation, E2E tests, Lighthouse audit, and build.

Lighthouse badges are published from CI to the gh-pages branch under lighthouse/*.json.

Add a new service template

npm run scaffold:service -- --service my-service --variant base --name "My Service" --category operations --description "My service description"

# categories: media, documents, operations, developer-tools, security

This scaffolds entries in:

  • src/templates/services/<service>/<variant>.compose.yaml
  • src/templates/services/<service>/<variant>.meta.json (field coverage and metadata starter)
  • src/templates/registry.ts
  • src/data/service-catalog.ts

Agentic Development

This project is developed with AI-assisted workflows using agents-opencode — a set of specialized agents for orchestration, implementation, review, and documentation.

About

Privacy-first web wizard to generate docker-compose.yaml and .env files for self-hosted services.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors