Skip to content
CloudZH

Docs / Customer guide

Step 6 of 10

Install CloudZH

Copy the installer to the server, run it and enter your license key. The installer itself takes 5 to 10 minutes.

Easier:

Create a ready-made command in your account and continue in the browser. See CloudZH Setup in the browser.

You need the installer file from My licenses → Download installer in your customer account and your license email. <user> and <server-ip> are from step 4; <file> is the name of the installer file, for example cloudzh-0.77.5-stable-customer.tar.gz.

  1. Copy the installer to the server

    On your computer, in the folder with the installer (Windows: PowerShell, for example after cd Downloads):

    scp <file> <user>@<server-ip>:~
  2. Unpack and start it

    ssh <user>@<server-ip>
    mkdir -p ~/cloudzh && tar xzf ~/<file> -C ~/cloudzh --strip-components=1
    cd ~/cloudzh && sudo bash install.sh

    sudo asks for the password of <user>.

  3. Answer the questions

    QuestionAnswer
    Domain (leave empty for LAN mode)Your domain, or empty for LAN mode
    Subdomain for the dashboardFor example app; Enter keeps dash
    Email for Let's EncryptYour email address
    Cloudflare-API-TokenPaste the token. It stays invisible while you type; the installer checks it with Cloudflare.
    Central data folderEnter, for /srv/data
    License key (CZL-…)A license key from your email or from My licenses. Each server needs its own key.

    After the installation you get an email Confirm new server. Check that the match code is the same as on your server and click Yes, this is me; the server activates by itself. With CloudZH Setup from your customer account there is nothing to confirm.

    Subdomain, email and Cloudflare token are asked only in domain mode. Leave the license key empty to activate later with sudo zh license activate CZL-…; until then CloudZH runs in restricted mode.

  4. Save the backup key

    At the end the installer shows the dashboard address and a setup token. Copy the backup key into your password manager; without it, backups cannot be opened:

    sudo cat /etc/cloudzh/backup.key

    Did /srv/data already hold media? Then also run sudo chown -R cloudzh:cloudzh /srv/data.

  5. Sign in for the first time

    Open the dashboard address: https://app.example.com with a domain, http://<server-ip> in LAN mode. Enter the setup token and create your administrator. Lost the token? zh token shows it again.

  6. Check

    Sign out of SSH and back in once, then:

    zh status
    zh doctor

    My account → Subscription in the dashboard shows the license of this server.