Getting Started
Create a Raklane account, connect your own server, and deploy your first app in a few minutes.
This walks you through creating an account, connecting a server you own, and deploying a real app end to end. It takes about ten minutes if you already have a server and a Git repository handy — or use the example repo below if you don't have a repo.
Raklane runs your apps on your own server — that's Bring Your Own Compute (BYOC). You'll need:
- A server running Ubuntu 20.04+ or Debian 11+, with its own public IPv4 address and ports
80and443open. A 1 vCPU / 1 GB VPS from any provider is enough to start: builds run on Raklane, not on your server. - Root or
sudoaccess to it over SSH, to run one install command.
Raklane Cloud is coming soon. Soon you'll be able to skip the server and run apps on servers Raklane manages. Until then, every app runs on a server you bring.
1. Create an account
Open the Raklane dashboard and sign up with an email address and password (at least 12 characters — Raklane cares more about length than about mixing in symbols).
Registration sends a verification email. Click the link in it before logging in — an unverified account can't sign in yet. If the email doesn't arrive, look for a "Resend verification email" option on the login page.
Signing up automatically creates a personal Organization for you — everything you build in Raklane (projects, apps, servers) lives inside an Organization. You can invite teammates into it later; see Teams & Organizations.
2. Connect your server
- In the dashboard, open Clusters and click Add server (or Add your first server).
- Give it a name, choose your provider, and click Continue.
- Copy the one-line install command the dashboard shows you, and run it on your server over SSH.
The command installs Docker, Caddy (which serves your apps over HTTPS) and the Raklane agent, then connects the server to your account. Within a minute or two the server shows up as Healthy — it's ready for deploys.
Raklane never logs into your server. The agent dials out to Raklane over one encrypted connection, and no extra port is opened. For the full walkthrough, including firewall tips, see Setting Up a BYOC Server.
3. Create a project
A Project is a folder for related apps — a backend/frontend pair, or all the services for one product. From the dashboard, click New Project and give it a name.
4. Create an app
Inside your project, click New App and give it a name. This name becomes part of your app's default URL, so pick something URL-friendly — lowercase letters, numbers, and hyphens.
You'll also choose a type:
- Deployment (the default) — a normal web app or API. Raklane detects your language/framework and builds a container image for you automatically.
- Static — a plain HTML/CSS/JS site with no server-side process. Raklane serves your files directly with no build step.
Most apps are Deployment. Use Static for something like a pre-built React/Vue app or a plain HTML site.
5. Point it at your code
Tell Raklane where your source lives. You have two options:
- A Git repository — paste your repo's URL and the branch/ref to deploy (e.g.
main). Public repos need nothing else; a private repo needs an access token — see Secrets for how to add one. - An uploaded archive — no Git repo? Zip or tar up your project and upload it directly.
Don't have a repo handy and just want to see Raklane work end to end? Use a small public example: https://github.com/heroku/node-js-getting-started, branch main.
6. Choose your server
The wizard's next steps let you add environment variables and set resources (the defaults are fine for a first app). On the final Review step, set the app's deployment location to BYOC and pick the server you connected in step 2. Only Healthy servers can receive a deploy.
You can move the app to another server later from Settings → Deployment location. See Where Your App Runs.
Raklane never bills your server's compute — your provider does. Raklane may charge a small management fee per server, taken from your prepaid wallet; see BYOC Billing.
7. Deploy
Click Deploy. Raklane builds a container image from your source (using Cloud Native Buildpacks — no Dockerfile required for most languages, though one in your repository is used if present), ships it to your server, starts it, and waits for it to pass a health check before sending it any traffic.
This is asynchronous — the dashboard shows the deploy moving through states: building → rolling_out → active (success) or failed. A first deploy typically takes anywhere from a few seconds to a couple of minutes, depending on how much there is to build. See Logs & Status for how to watch this happen and read your app's logs if something goes wrong.
8. Visit your app
Once the deploy is active, your app's overview page shows its URL — an HTTPS address under byoc.raklane.com that points straight at your server and works immediately, no DNS setup required. Open it in a browser.
Want your own domain instead (app.yourcompany.com)? See Custom Domains.
What's next
- How Raklane Works — what happened behind the scenes, end to end.
- Running Apps & Databases on BYOC — default URLs, custom domains, and databases on your server.
- Deploying Your App — replicas, resource limits, redeploying, and rolling back.
- Auto-Deploy & Deploy Modes — have every
git pushdeploy automatically. - Environment Variables and Secrets — configuration and private repos.