Cresdock  /  Deploy Guide

Deploy Cresdock — the simple setup guide

Cresdock installs onto a server you own with a single command. This guide takes a non-technical admin from nothing to a running panel: which server to get, what specs you need, and exactly what happens during install. Plan for about 15 minutes.

🧭
The whole thing in one line: get a cheap Ubuntu server, paste one command, copy the password it prints, and log in. Everything below is just the detail so nothing surprises you.

1.What you need

Three things — no coding and no Docker knowledge:

  1. A server

    A rented cloud server (a “VPS”) or a spare computer at home. We’ll pick the right one in the next step.

  2. About 15 minutes

    And the ability to copy-and-paste one command.

  3. A domain name (optional, but recommended)

    Something like panel.yourname.com. It gives you proper padlock—HTTPS and tidy links. You can skip it for a quick test.

2.Pick a server — OS and specs

Operating system: use Ubuntu 22.04 (or newer) or Debian 12 (or newer). These are the two we test on, both are free, and every cloud provider offers them as a one-click choice when you create a server. Please don’t use Windows or macOS — Cresdock runs on Linux.

How much power? Match this to how many people will use it:

MinimumComfortableWhat it affects
CPU2 cores4+ coresMore people and more running apps want more cores.
Memory (RAM)4 GB8–16 GBEach active app uses some; RAM is the first thing to run low.
Disk~30 GB for the systema big data diskYour files (downloads, media) live here — size it for what you’ll actually store, e.g. 1–4 TB.

Where to get one: any major provider works — Hetzner, DigitalOcean, OVH, Contabo and others. When creating the server, choose Ubuntu 22.04, at least 2 CPU / 4 GB RAM, and add storage for your files. A home mini-PC running Ubuntu works too.

💸
Just testing? Even a small 2-core / 4 GB server runs a personal setup fine. You can always move to a bigger one later — your data isn’t locked in.

3.Point a domain at your server (recommended)

A domain gives you real, trusted HTTPS and clean web addresses. At your domain registrar (where you bought the name), add two records that point at your server’s IP address:

TypeNamePoints to
Apanel.yourname.comyour server’s IP
A*.panel.yourname.com (a “wildcard”)your server’s IP

The wildcard (the one starting with *.) matters: streaming apps like Plex and Jellyfin get their own web address, and this makes those work. Also open ports 80 and 443 on the server (most cloud servers have these open already).

No domain yet? Skip this step. The installer can run in test mode with a temporary local certificate — your browser will show a one-time “not secure” warning you can safely click past while trying it out.

4.Run the installer

Connect to your server (your provider shows you how — it’s usually a “Console” button or an ssh command), then paste this one line and press Enter:

curl -fsSL https://get.cresdock.com | sudo bash

That’s the entire install. It will ask you one or two simple questions (your domain, and whether to get real HTTPS certificates) — press Enter to accept the sensible default each time.

Power users: install without any questions

Provide everything up front to run unattended:

curl -fsSL https://get.cresdock.com | sudo bash -s -- \
  --domain panel.yourname.com \
  --email you@example.com \
  --tls letsencrypt \
  --data-dir /mnt/storage
OptionWhat it does
--domainYour panel’s domain (needs the two DNS records above).
--tlsletsencrypt = automatic real certificates (needs --email + public DNS); selfsigned = local test cert; none = handle HTTPS yourself.
--data-dirWhere all files live — point this at your biggest disk.
--routingpath (default) or subdomain for app addresses.

5.What to expect during install

The installer runs on its own — here’s what it’s doing so nothing looks alarming:

  1. Installs Docker

    If your server doesn’t already have it, the installer adds it for you.

  2. Generates your passwords & secrets

    Everything is created fresh and unique to your box — nothing is shared or preset.

  3. Sets up the panel and its private networking

    Including isolating each future user so they can never see each other’s apps.

  4. Requests HTTPS certificates

    If you chose a real domain, it gets trusted certificates automatically.

  5. Starts everything up

    A few minutes later the panel is live.

🔑
Write down the login it prints. When it finishes, the installer shows your admin username and a generated password. Copy them somewhere safe — that’s how you sign in.
Good to know: re-running the installer later is always safe — it upgrades in place and never touches your files or user data.

6.First login

  1. Open your panel

    Go to https://panel.yourname.com/ (or the local address the installer printed if you skipped the domain).

  2. Sign in

    Use the admin username and password from the end of the install.

  3. Secure your account

    Set your email, change to a passphrase you’ll remember, and turn on two-factor authentication under Profile → Security. Recommended, since this account controls the whole box.

7.Use it solo, or add people

Out of the box your server runs one user — perfect for a personal setup. Install apps and you’re done.

Want to share it with family, friends, or paying customers? Each person gets their own private, isolated space:

  1. Go to Users → Add user

    Enter their email to send an invite link (they set their own password).

  2. Pick their plan

    Set how much disk, how many apps, and their speed limits — right there on the form.

  3. They take it from there

    Point them at the user guide for installing and using their apps.

8.If something goes wrong

You see…What’s happening & the fix
Browser warns the site “isn’t secure”You’re in test mode with a local certificate. Add a real domain and re-run with real certificates for a trusted padlock.
A streaming app “won’t load”Almost always a missing wildcard DNS record (*.yourname.com). Add it, then rebuild the app.
HTTPS certificate didn’t come throughMake sure ports 80 and 443 are open and both DNS records point at the server, then re-run.
Ran out of disk spaceYou likely installed onto the small system disk. Re-run the installer with --data-dir pointing at your big disk.
🛟
Let the box help itself. If you turn on self-healing (Admin → System → Support), Cresdock reports and often fixes problems automatically — a crashed app is usually back before you notice.