> A single-host PaaS. Point it at an image or a git repo, fill a form, hit deploy, and Traefik routes it with TLS. No Kubernetes anywhere near it. > Source: https://orochibraru.com/homerun/docs · Site index: https://orochibraru.com/llms.txt # Homerun documentation A single-host PaaS. Point it at an image or a git repo, fill a form, hit deploy, and Traefik routes it with TLS. No Kubernetes anywhere near it. The Markdown in [the project repo](https://github.com/orochibraru/homerun/tree/main/docs) is the source of truth; these pages are generated from it. - [Homerun](https://orochibraru.com/homerun/docs/readme.md): A self-hosted, single-user PaaS for deploying Docker containers with a click-config form: a minimal Dokploy / Cloud Run alternative for your own hardware. - [Contributing to Homerun](https://orochibraru.com/homerun/docs/contributing.md): This is the "I want to run this from source and change code" guide. If you just want to run Homerun, you don't need any of this: use the installer one-liner or… - [Getting started](https://orochibraru.com/homerun/docs/getting-started.md): Homerun needs three things at runtime: a Docker socket to manage containers, a Postgres database, and Traefik for routing and TLS. Pick whichever install path… - [Showcase](https://orochibraru.com/homerun/docs/showcase.md): Every screenshot below is generated by driving a real instance with Playwright (bun run screenshots): a blank database, a real sign-up, the onboarding wizard… - [Configuration](https://orochibraru.com/homerun/docs/configuration.md): Almost everything is a setting in the dashboard. The first-run wizard asks for what a first deploy needs, and /settings (admin-only) lets you change any of it… - [FAQ & limitations](https://orochibraru.com/homerun/docs/faq-and-limitations.md): Homerun is new. If you're used to another self-hosted PaaS, most of what you expect is here, but some things work differently and a few aren't built yet. This… - [Services](https://orochibraru.com/homerun/docs/services.md): A service is one deployed container. Create one from Services → New, either standalone or pre-filled from a stack or template via ?stackId=/?templateId=. The… - [Deploy source and build methods](https://orochibraru.com/homerun/docs/deploy-source-and-builds.md): Where a service's image comes from, how a git-based service is built, and which machine builds it. - [Connecting a git provider](https://orochibraru.com/homerun/docs/git-providers.md): 1. An admin registers the provider, once. For GitHub, give the app a name (and an organization, or leave it empty for your personal account) and click Create… - [Deploy on push](https://orochibraru.com/homerun/docs/deploy-on-push.md): Turn on Deploy on push on the Source tab (or in the wizard) and every push to the service's branch deploys it, as its owner, without you touching the dashboard. - [Pull request previews](https://orochibraru.com/homerun/docs/pull-request-previews.md): Tick Pull request previews on a git service's Source tab and every pull request opened on its repo gets a service of its own, -pr- (so… - [Required status checks](https://orochibraru.com/homerun/docs/status-checks.md): A git-mode service can refuse to build until its CI agrees. On the Source tab, tick Require status checks to pass before building and pick the checks that must… - [Importing a compose file](https://orochibraru.com/homerun/docs/compose-import.md): Import compose on the services list takes a docker-compose.yaml pasted straight in and turns it into Homerun rows. Parsing happens on the server and nothing is… - [Migrating from Dokploy or Coolify](https://orochibraru.com/homerun/docs/migrating-from-dokploy-or-coolify.md): Settings → Migrate (admin-only) reads another PaaS instance and recreates what it finds here. Pick Dokploy or Coolify, give it the instance URL and an API… - [Deploying](https://orochibraru.com/homerun/docs/deploying.md): The Overview tab has Deploy/Start/Stop/Restart plus a live progress panel. The panel shows six phases, resolving configuration, preparing volumes, fetching… - [Revisions and rollback](https://orochibraru.com/homerun/docs/revisions-and-rollback.md): Every deploy that reaches running is a revision: the exact image it ran (image:tag plus the registry digest when there is one, or the local… - [Image scanning](https://orochibraru.com/homerun/docs/image-scanning.md): Every deploy scans the image for known vulnerabilities with Trivy before the workload starts. It's on by default and never enforced unless you ask for it. - [Env vars](https://orochibraru.com/homerun/docs/env-vars.md): Plain key/value rows on the Env Vars tab, stored as-is (not encrypted, don't put a raw plaintext secret you'd mind leaking in the DB dump into an env var if you… - [Networking](https://orochibraru.com/homerun/docs/networking.md): Everything on this tab is written onto the container as Traefik labels at create time, so saving a change here doesn't affect the container that's already… - [DNS automation](https://orochibraru.com/homerun/docs/dns-automation.md): If your instance's DNS is on Cloudflare, or you front it with a self-hosted Pangolin tunnel instead, configure one (or both) from /settings → Networking and… - [Runtime and compute](https://orochibraru.com/homerun/docs/runtime-and-compute.md): How a service's container starts, what it can reach on the host, and how much CPU and memory it gets. - [Swarm mode](https://orochibraru.com/homerun/docs/swarm-mode.md): Instance-wide (/settings → Docker → Orchestration mode), and what the one-line installer sets up: the installer makes the system Docker daemon a swarm manager… - [Observability](https://orochibraru.com/homerun/docs/observability.md): The Observability tab is where a service tells you whether it's healthy: uptime probes, live logs, failed deploys and the errors Homerun logged about it. - [Scheduling and the job queue](https://orochibraru.com/homerun/docs/scheduling.md): Everything that runs on a timer or in the background: scheduled redeploys, cron jobs, the Scheduling page that lists them, and the job queue behind all of it. - [Stacks](https://orochibraru.com/homerun/docs/stacks.md): A stack groups services together and gives them a shared, private Docker network, member services can reach each other by plain slug (http://api:8080), separate… - [Templates](https://orochibraru.com/homerun/docs/templates.md): A template is a saved service config (image, tag, container port, env vars, CPU/ memory, and the runtime options: entrypoint, command, labels, env files, added… - [Storage volumes](https://orochibraru.com/homerun/docs/storage-volumes.md): A storage volume (/storage) is a named source you define once, then mount into one or more services from each service's Volumes tab: - [S3 backups](https://orochibraru.com/homerun/docs/backups.md): Back up storage volumes to any S3-compatible bucket, on a schedule or on demand, and restore them from the dashboard. - [Build servers & the Homerun Agent](https://orochibraru.com/homerun/docs/remote-hosts-and-agent.md): Services always deploy to this host's own Docker daemon. Placement across machines is swarm mode's job: a second machine joins the swarm as a worker… - [Users and roles](https://orochibraru.com/homerun/docs/users-and-roles.md): Homerun has three roles, admin, developer and read-only. Every account sees every resource on the instance, and every admin or developer account manages it… - [Authentication providers](https://orochibraru.com/homerun/docs/authentication-providers.md): The Authentication page (Administration, admin-only) is where sign-in methods are configured for the whole instance: - [Your profile](https://orochibraru.com/homerun/docs/your-profile.md): The profile pages (reached from the avatar menu, not the sidebar) are per account: - [Two-factor authentication and passkeys](https://orochibraru.com/homerun/docs/two-factor-and-passkeys.md): Both live under Profile → Security. - [Per-app login wall](https://orochibraru.com/homerun/docs/login-wall.md): A deployed service can require a login before anyone reaches it. Turn on Require login to access this app on the service's Security tab, under Login wall. - [Sign in with Homerun](https://orochibraru.com/homerun/docs/sign-in-with-homerun.md): Homerun is also an OpenID Connect (OIDC) provider. Apps you host can offer "Sign in with Homerun" using the same accounts as the dashboard, so you don't need to… - [The dashboard](https://orochibraru.com/homerun/docs/dashboard.md): The Search… button in the header, or ⌘K / Ctrl+K anywhere, opens a command palette. It jumps to any dashboard page by name, and once you've typed two characters… - [System Logs](https://orochibraru.com/homerun/docs/system-logs.md): This instance's stack lists every container your compose file starts, Homerun itself, Postgres and Traefik included, with its state. Click one to open its live… - [Docker Cleanup](https://orochibraru.com/homerun/docs/docker-cleanup.md): The page previews what's actually reclaimable before you commit, unused images, stopped containers, unreferenced volumes, unused networks (excluding Docker's… - [Notifications](https://orochibraru.com/homerun/docs/notifications.md): The bell in the header is a per-account feed of lifecycle events on every service, whoever created it (each account gets its own copy to read and clear), deploy… - [Status pages](https://orochibraru.com/homerun/docs/status-pages.md): Status Page in the sidebar builds an uptime page out of your services' uptime probes. Each page has a name, a slug and an optional description, and covers one… - [Upgrading Homerun](https://orochibraru.com/homerun/docs/upgrading.md): The sidebar shows the version you're running. Admins also see a notice there when a newer GitHub release exists (checked every ten minutes). Clicking it opens… - [API & CLI](https://orochibraru.com/homerun/docs/api-and-cli.md): An API key is created with Full access or Read-only access (see API keys). A read-only key, or any request from a read-only account, can call every GET… - [Registry](https://orochibraru.com/homerun/docs/registry.md): Every repository the registry holds, with its tags, the digest each tag currently points at, and which of your services reference that repository (an image…