Documentation

In your welcome email you received file called docker-compose.yaml. You will need to edit some fields in it in order to deploy Agendex properly.

First, create the root directory where Agendex will be running, e.g. /opt/agendex, or D:/Agendex. Then save the YAML file to the disk, in the root Agendex directory. Open it with your preferred text editor. Make sure not to change the tabulation of the file!

Initially the file looks something like that:

version: '3'
services:
agendex-ce:
image: agendex/agendex-community-edition:latest
container_name: agendex-ce
hostname: agendex-ce
restart: always
environment:
AGNDX_ID: mycompany.com
AGNDX_DOMAIN: mycompany.com
AGNDX_CLIENT: https://agendex.mycompany.com
AGNDX_SERVER: https://agendex.mycompany.com
AGNDX_ADMINS: john@mycompany.com
AGNDX_COMPANY: My Company Ltd.
AGNDX_NAME: Agendex
AGNDX_SECRET: QU7naZyV1DSb
AGNDX_PORT: '3000'
volumes:
- /path/on/host/db:/opt/agendex/db
ports:
- '3000:3000'

Edit the file, so that:
 – AGNDX_SERVER and AGNDX_CLIENT fields both hold the correct URL for Agendex (e.g. https://agendex.mycompany.com). The YAML will have an automatically generated URL: https://agendex.{yourdomain}, where {yourdomain} is the domain with which you registered on https://docs.agendex.com;
 – the first part of the line after ‘volumes:’ matches the Agendex Data Directory, mentioned above.

Note:
On Windows the path shall be written using Windows standards, e.g. with backslash (‘\’) as delimiter between directories.

Edit the port mapping at the end of the file. The left part of the mapping is what the exposed port will be, the right part – the port used by Agendex inside the container. We recommend that you avoid altering this value. In any case the port in the right part of the ‘ports:’ field should match the one after AGNDX_PORT.

Optionally, you may edit the secret code (AGNDX_SECRET), the company name (AGNDX_COMPANY) and the product name (AGNDX_NAME). The product name must be present, but is reserved for future version of Agendex, capable of ‘white-labelling’.

Although you may add admin users inside Agendex, you may add additional admins here, separating them with a comma, without any white spaces.

After editing, the yaml file shall look like this:

version: '3'
services:
agendex-ce:
image: agendex/agendex-community-edition:latest
container_name: agendex-ce
hostname: agendex-ce
restart: always
environment:
AGNDX_ID: mycompany.com
AGNDX_DOMAIN: mycompany.com
AGNDX_CLIENT: https://agendex.mycompany.com
AGNDX_SERVER: https://agendex.mycompany.com
AGNDX_ADMINS: john@mycompany.com,leah@mycompany.com
AGNDX_COMPANY: My Company Ltd.
AGNDX_NAME: Agendex
AGNDX_SECRET: QU7naZyV1DSb
AGNDX_PORT: '3000'
volumes:
- /opt/agendex/db:/opt/agendex/db
ports:
- '8080:3000'

Note: You can also define a specific interface for the port mapping, e.g.: ‘10.0.0.1:8080:3000’

What are your feelings
Updated on March 26, 2021
Scroll to Top