Installation and setup

First, clone the repo.

git clone https://github.com/Sycration/CZ4R
cd CZ4R

To configure, copy .env.template to .env and modify the values in there to your liking. Don't set the username and password to something important, you will delete this account soon. You can find the required TZ (timezone) string at this site https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

To configure backups in an AWS S3 bucket, just set the appropriate environment variables in .env. Everything should work automatically, including downloading the database from the bucket if it already exists.

Next, to run CZ4R, use the update.sh script, which itself uses docker compose. If you don't have docker, see here https://docs.docker.com/engine/install/

docker compose build
docker compose up -d

If you want to run CZ4R without docker, this is possible too, just make sure the database URL in .env points to a directory that exists and that you have permissions to write to.

The web UI will be exposed on port 3000 by default.

Next page