Repository navigation
Add self-hosting deployment guide and interactive setup script - #2
Merged
Merged
Conversation
JDB321Sailor
approved these changes
Jul 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a complete self-hosting option under
deploy/for running the JetKVM cloud API and dashboard on any Docker host.Changes
deploy/setup-deployment.sh— interactive builder that generates everything needed to run the stack in thedeploy/folder:compose.yaml— Traefik v3 reverse proxy, Postgres 16, a one-shot Prisma migration job, the cloud API (built from the repoDockerfile), and the dashboard UI built directly from a siblingkvmrepository checkout and served by CaddyCaddyfile— static SPA file server config for the built dashboard.env(chmod 600) — generated secrets, domains, and OIDC settings matching.env.examplesetup-deployment.env(chmod 600) — persistent answers file;AUTORUN=trueenables fully non-interactive reruns,AUTORUN=falsepre-fills prompts with prior answershttps://<api-domain>/oidc/callback)POSTGRES_PASSWORDandCOOKIE_SECRET, so an initialised Postgres volume keeps workingdeploy/deployment.md— self-hosting guide covering prerequisites, DNS/TLS, OIDC provider registration, running the setup script, custom JetKVM device build pointing at the self-hosted cloud URL, and troubleshootingValidation
bash -nsyntax check passesAUTORUN=true) run produces acompose.yamlthat passesdocker compose config.env.envkeys,/oidc/callbackroute, and/healthzendpoint verified againstsrc/