Chevereto V4 docs

# 🐋 Docker

TIP

This is the best way to deploy Chevereto. You can use PURE DOCKER or our all-included project tooling.

Docker refers to container technology and is the way in which we ship the server infra needed to run Chevereto. By using Docker you don't need to worry about the system libraries and it is the recommended way to deploy Chevereto.

# Advantages

There are several advantages of our Docker system:

  • 🤹 Run multiple websites in the same machine
  • 📱 Portability
  • 🚀 Easy to update
  • 👮‍♂️ More secure
  • 🔐 Automatic HTTPS setup
  • 🌎 CloudFlare integration

# Repository

Check the project repository at chevereto/docker (opens new window) for all instructions and source code.

# Requirements

For this guide you will require the following:

  • Unix-like server with shell access
  • Hostname pointing to server
    • mywebsite.com pointing to sever IP
  • Chevereto license (when using our paid edition)
  • Optionally, CloudFlare API credentials to automatic handle sub-domains for you.

See CloudFlare (opens new window) for instructions on how to setup automatic DNS integration

# Pure Docker

If you want full control of the container provisioning you can get our base image at:

ghcr.io/chevereto/chevereto:latest

You can get this container running with the following command:

docker run -d \
  --name chevereto \
  -p 80:80 \
  -e CHEVERETO_DB_HOST=database \
  -e CHEVERETO_DB_USER=chevereto \
  -e CHEVERETO_DB_PASS=user_database_password \
  -e CHEVERETO_DB_PORT=3306 \
  -e CHEVERETO_DB_NAME=chevereto \
  -e CHEVERETO_ASSET_STORAGE_TYPE=local \
  -e CHEVERETO_ASSET_STORAGE_URL=/images/_assets/ \
  -e CHEVERETO_ASSET_STORAGE_BUCKET=/var/www/html/images/_assets/ \
  -v /var/www/html/images/ \
  ghcr.io/chevereto/chevereto:latest

Refer to PURE-DOCKER (opens new window) for a complete pure Docker command reference. Also check our default.yml (opens new window) compose file.

👉 If you have a Pro license you will require to build the system image.

# Getting a server

For this guide you will require a machine where you can install Docker (opens new window) as in this machine (referred as server host) you will install Chevereto and expose it to the internet.

For this guide we will use an Ubuntu server.

You can purchase a server from our partners (Linode (opens new window), Vultr (opens new window)) including free credits.

# Shell access

The shell is a command-line interface that enables to remote control the server. To access to this interface you need terminal emulator software.

Here are common-used terminal emulators by operating system:

System Software
macOS Terminal, iTerm 2
Windows Windows Terminal, Putty
Linux Gnome Terminal, Tilix, XTerm

Once you get shell access check that your server has make, unzip, curl and git installed.

sudo apt install make unzip curl git

# Cloning chevereto/docker

We will use git to get a copy of our base Docker project. By running the following command a docker folder will be created in the current working directory.

git clone https://github.com/chevereto/docker.git

Go to this newly created docker folder.

cd docker

While on docker folder you can work with our Docker base project.

# Installing Docker

If you are using Ubuntu you can install Docker by running:

make install-docker

For other systems follow the instructions for Docker Engine installation (opens new window). Check at Server for your specific Linux distribution.

Docker Engine installation

Installation overview

# Setup background jobs

Chevereto needs to execute periodic systems tasks on the background like deleting expired images, unverified users or to check for updates.

Run the following command to setup background processing for all your websites.

make cron

# Create HTTPS proxy

We include an NGIX web server that will forward access to all your Chevereto websites and provide auto renewable HTTPS certificates.

To setup our proxy server run the following command:

make proxy EMAIL_HTTPS=mail@yourdomain.tld

At EMAIL_HTTPS option pass your email. It is required for HTTPS certificate notifications

# Build Chevereto image

This process builds the Chevereto container image.

💡 Omit this step when using free edition as the image is available at GHCR (opens new window).

make image

The process will ask for your license key.

If no license is provided or you enter an invalid license the system will build the free image.

# Setup namespace

A namespace (opens new window) is a file that defines the context of your project. It is where the system stores your project variables.

To create the example namespace for mywebsite.com hostname:

make namespace NAMESPACE=example HOSTNAME=mywebsite.com

You can check the namespace files at ./namespace folder.

# Spawn Chevereto website

To create a new website run make spawn command by passing the NAMESPACE option.

make spawn NAMESPACE=example

💡 When using free edition pass EDITION=free.

make spawn NAMESPACE=example EDITION=free

🎉 Congratulations! Chevereto is now up an running.

To create more websites repeat the steps from Setup namespace for each additional website you want to spawn.

# Updates

Refer to UPDATING (opens new window) for instructions on how to update Chevereto when using Docker.

← 🏝 VPS →