Digital Ocean

Create a Droplet

Create a Droplet with the appropriate resources. For this guide, we will use a recommended configuration with Docker pre-installed.

Read our Resourcing guide for more details.

Give your Droplet a descriptive name like zortex-prod
Select a region close to your users
Select the Docker image from the Marketplace tab
Choose a Droplet size with at least 4 vCPUs and 16GB RAM
Configure storage following the Resourcing Guide
Add your SSH key for secure access

Create the Droplet

Click Create Droplet and then view your Droplet details.

Save the Public IP address of the Droplet!

Point domain to the instance

If you don’t have a domain, buy one from a DNS provider like GoDaddy or just skip HTTPS for now.

To point our domain to the new instance, we need to add an A and CNAME record to our DNS provider.The A record should be the subdomain that you would like to use for the Zortex instance like prod.The CNAME record should be the same name with the www. in front resulting in www.prod pointing to the full domain like prod.zortex.me. DNS A Record Configuration

Install Zortex requirements

Since we selected the Docker Marketplace image, Docker and Docker Compose are already installed.We just need to install git:

sudo apt update
sudo apt install -y git

Install and Configure Zortex

To install Zortex, we’ll need to clone the repo and set the necessary environment variables.

git clone --depth 1 https://github.com/zortex-ai/zortex.git

cd zortex/deployment/docker_compose
cp env.prod.template .env
cp env.nginx.template .env.nginx

Fill out the .env and .env.nginx files.

.env

WEB_DOMAIN=<YOUR_DOMAIN>  # Something like "zortex.me"

# If your email is something like "chris@zortex.me", then this should be "zortex.me"
# This prevents people outside your company from creating an account
VALID_EMAIL_DOMAINS=<YOUR_COMPANIES_EMAIL_DOMAIN>

# See our auth guides for options here
AUTH_TYPE=

.env.nginx

DOMAIN=<YOUR_DOMAIN>  # Something like "zortex.me"

Launch Zortex

Running the init-letsencrypt.sh script will get us a SSL certificate from letsencrypt and launch the Zortex stack.

./init-letsencrypt.sh

You will hit an error if you fail the letsencrypt workflow more than 5 times. You will need to wait 72 hours or request a new domain.

If you are skipping the HTTPS setup, start Zortex manually:

docker compose -f docker-compose.dev.yml -p zortex-stack up -d --build --force-recreate

Give Zortex a few minutes to start up.You can monitor the progress with docker logs zortex-stack-api_server-1 -f.

You can access Zortex from the instance Public IPv4 or from the domain you set up earlier!

Getting Started

Deploy Locally

Zortex Anywhere

Deploy on Cloud

Authentication

Miscellaneous

Next Steps

Configure Authentication

More Zortex Configuration Options

​Next Steps

Configure Authentication

More Zortex Configuration Options

Next Steps