Skip to main content

Documentation Preview

Comix Cleric is still being developed. This is a preview of how we expect Comix Cleric to operate. This documentation will in no way reflect the depth or quality of the official documentation. Stand by for updates.
docs > self-host

Installation

Comix Cleric currently only offers self-hosted installation via Docker. This means you will need to have Docker installed on the system you wish to run this web app.

If you have a better idea or want to see another deployment method supported, reach out on Discord!
On This Page

Getting Started

At this time, Comix Cleric requires a server/VPS (1 CPU core, 1GB RAM minimum) with Docker installed. This is a technical limitation imposed by the database.

Log into your host’s panel and make sure that your are able to either request a VPS with root access or the ability to upload files to a Docker environment.

For more information, follow this guide. (Coming soon)

This may seem daunting, but we'll guide you through!

Once you have a Docker environment ready, either locally for development or live on the internet, download the official Comix Cleric monorepo from GitHub, which contains all the files you need to develop and deploy the app via Docker.

Upload and unpack the files to a new directory. Example my-cc-app

Starting the Reader & Admin Panel

In a terminal, open an ssh connection to your server. This normally looks like: ssh root@myappdomain.com.

Move into the directory you unpacked your files into. cd my-cc-app

Make sure that at least package.json, pnpm-lock.yaml, dockerfile, docker-compose.yml, /build, & /api exist there. Those are the core files needed to run Comix Cleric.

In the dockerfile & docker-compose.yml, you will find a few instances of a port number. The default is fine, assuming you don’t have something using that port at the time. You can also change this to any port number you wish, also assuming that’s it’s not already in use.

We also advise that you give your Docker container a unique name, just in case you want to run other types of applications.

Some environments differ. The following commands with either be docker compose or docker-compose depending on your installation. If one doesn’t work, try the other.

Run docker compose up -d --build to start up the Comix Cleric reader and admin panel.

A quick & dirty breakdown of this command is: docker compose (or docker-compose) initiates an operation with a docker-compose.yml file; up says you’d like to launch the container; -d tells the terminal process that you’d like it to continue in the background using the “default driver”, & --build tells it that you need to build the container image (app) from the instructions in the dockerfile.

Starting the Database

Move into the /api directory via cd api, and run docker compose up -d. Note that you should not run --build at the end of this one.

The database can take a while to start at times (10-30 seconds).

Making the App Live

This is highly dependent on your host. We will provide additional details as they become available.

Taking the App or Database Offline

In both cases, you will need to be either in the main app or api directory, and run docker compose down. This command will look for the container in the active directory and tell Docker to stop running it immediately. To stop both, you will have to run this command in each respective directory.