Quickstart

1. Create your admin account

When you open the dashboard for the first time and no account exists yet, you'll see a registration form. Enter your email and a password (8+ characters) to create the admin account, which has full control over the platform. Registration closes after the first user: everyone else is invited by an admin from Users. If you passed --admin-email to the installer and it succeeded, just log in.

2. Follow the Welcome checklist

The dashboard shows a Welcome to DeployKit card until you deploy your first application or database. It walks you through three steps:

• Connect a server — click “Use local server” to register the machine DeployKit runs on (admins only), or add a remote server over SSH from Servers
• Create a project — projects group related applications, databases, stacks and game servers, and carry their own member roles
• Deploy from a template — “Browse templates” opens the one-click catalogue of databases, self-hosted apps and full stacks

3. Add an application

To deploy your own code instead of a template, open the project and click Add Application. Pick the source (GitHub, GitLab, any Git URL, or a Docker image), the branch, the build type (Nixpacks for auto-detection, Dockerfile, or Buildpacks), the target server, and the port your app listens on. If a GitHub App is connected you can pick the repository from a list — private repos included, no access token needed. The same project page also has Add Database, Add Stack and New game server.

4. Deploy

Click Deploy on the application page. DeployKit clones the repository, builds a Docker image, starts the container with Traefik labels for routing, and runs the health check. Follow the build logs in real time from the Deployments tab. Then add a domain to the application and point its DNS at the server — the certificate is issued automatically.