githubEdit

🐰Conserver Quick Start

A quick start to getting the conserver up and running

Ubuntu Install

Based on a digital ocean install, to keep it vanilla. Created a 4 GB Memory / 2 Intel vCPUs / 120 GB Disk / NYC3 - Ubuntu 23.04 x64 droplet, logged in.

snap install docker
git clone https://github.com/vcon-dev/vcon.git
cd vcon/
git submodule sync
git submodule update --init --recursive
cd vcon-server/
git checkout main
cd ..
cd vcon-admin/
git checkout main
cd ..

Conserver Start

The conserver repo can be downloaded directlyarrow-up-right, but is also included in the vcon repo in the von-server directory.

cd vcon-server

Create an ~/vcon/.env file. See example .env below. *Note that the default URL for REDIS assumes it is running in a docker container, thus the hostname "redis".

Example vcon-server/config.yml

Most of the configuration is done through the config.yml file. Here's a very simple one. Inbound vCons in the ingress chain cause a slack webhook into a workflow, then it will be stored in mongo.

Standalone Operation

When running a conserver in "standalone mode" (using vcon-admin as a simple portal, which will also provide the basic versions of all of the apps and databases), it will automatically register a domain name and generate a valid SSL certificate using LetsEncrypt, assuming that the domain name has an A record pointing to your server.

Start the Conserver

Troubleshooting and Checking

You can validate that the conserver is running on the command line using "docker ps". In the example below, we can see four instances running.

You can see the operational logs using "docker compose logs -f". Here's a typical log:

The vCon admin programarrow-up-right is a nice tool for managing the conserver.

Last updated

Was this helpful?