Installation

To install the software, follow these instructions on an Ubuntu 24.04 LTS server, which is a Docker Stack being deployed.

Default Login Credentials:

Minimum Server Requirements:

  • CPU: 2 cores
  • RAM: 4 GB
  • Storage: 40 GB SSD

Recommended Server:

For optimal performance and value, we recommend the Hetzner CX32 (€6.30/month) which offers:

  • CPU: 4 cores (Intel Performance)
  • RAM: 8 GB
  • Storage: 80 GB SSD

Step 1 - Update & Upgrade

The very first thing we do is update the package lists and packages on the server so that we are up to date.

apt update

apt upgrade

Step 2 - Install Dependencies

Now we install the necessary dependencies for the software, including Docker.

apt -y install unzip wget curl

curl https://get.docker.com | sh

Step 3 - Download files from LIVCK

Before downloading:

  1. Get your license key from LIVCK Dashboard
  2. Add your server's IP to the license allowlist
  3. Replace PLACEHOLDER-LICENSE in the command below with your actual license key
cd /opt && wget -4 https://livck.com/dl/self-hosted/PLACEHOLDER-LICENSE -O livck.zip

Step 3.1 - Unpacking LIVCK files

unzip livck.zip

Step 3.2 - Move LIVCK files to correct folder

mkdir livck && mv LIVCK-self-hosted-*/* /opt/livck

Step 3.3 - Delete useless files

rm LIVCK-self-hosted-* -R && rm livck.zip

Step 4 - Configure Application

Go into the livck folder

cd livck

Step 5 - Run the installation script

Give the script the correct permissions and run it

chmod +x install.sh

./install.sh

  1. If you choose to proceed with the installation, you will be prompted to provide the following information:

    • Project name (*)
    • License key (*)
    • Protocol preference (IPv6 -> 6, IPv4 -> 4, or press Enter)
    • Domain (e.g., status.livck.com, without the protocol prefix) (*)
    • Notification providers configuration (y/n)? (*)
      • If yes, you will be asked to enter the Telegram Bot token and Pushover token.
    • Mail server configuration (y/n)? (*)
      • If yes, you will be asked to enter the Mail Host, Mail Username, Mail Password, Mail Host Port, and Mail Encryption.
    • Using SSL for secure traffic (y/n)? (*)
      • If yes, you will be asked to enter the email address for ACME (Let's Encrypt / Certbot) service.

  2. The script will generate an environment file named .env based on the provided information.

  3. A sample Nginx site configuration file will be copied as docker/web/sites/default.conf.

  4. The script will start the required Docker containers using docker-compose up -d.

  5. If SSL is enabled, the script will ask for an email address and run Certbot to obtain SSL certificates for your domain.

  6. Once the containers are running, the script will execute additional setup commands, such as database migration and caching.

  7. The script will set the necessary permissions for the application files.

  8. The installation process will be completed, and the script will display the following information:

    • Status page URL
    • Login credentials (URL, E-Mail, and Password)