Skip to content

Latest commit

 

History

History
 
 

docker

README.md

Quick project reference

Prerequisites

Please note it is important to use the abovementioned version of docker-compose or newer, otherwise the build and deploy will fail.

Deployment

Clone via git

git clone --depth 1  https://github.com/taranis-ai/taranis-ai
cd taranis-ai/docker/

Configuration

Copy env.sample to .env

cp env.sample .env

Open file .env and defaults if needed

Startup & Usage

Start-up application

docker compose up -d

Use the application

http://<url>:<TARANIS_PORT>/login

Development

See dev Readme for a quick way to get a development environment running.

Initial Setup 👤

The default credentials are user / user and admin / admin.

Open http://<url>:<TARANIS_PORT>/config/sources and click [Import] to import json-file with sources (see below)

Advanced monitoring

Taranis AI supports advanced monitoring of gui, core and database using Sentry. It can be enabled by setting respective SENTRY_DSN environment variables described below.

Advanced build methods

Individually build the containers

To build the Docker images individually, you need to clone the source code repository.

git clone https://github.com/taranis-ai/taranis-ai

Afterwards go to the cloned repository and launch the docker build command for the specific container image, like so:

cd Taranis AI
docker build -t taranis-core . -f ./docker/Containerfile.core
docker build -t taranis-gui . -f ./docker/Containerfile.gui
docker build -t taranis-worker . -f ./docker/Containerfile.worker

There are several Dockerfiles and each of them builds a different component of the system. These Dockerfiles exist:

Configuration

Container variables

rabbitmq

Any configuration options are available at https://hub.docker.com/_/rabbitmq.

database

Any configuration options are available at https://hub.docker.com/_/postgres.

core

Environment variable Description Default
TARANIS_AUTHENTICATOR Authentication method for users. database
QUEUE_BROKER_HOST RabbitMQ Host address rabbitmq
QUEUE_BROKER_USER RabbitMQ user taranis
QUEUE_BROKER_PASSWORD RabbitMQ password supersecret
PRE_SEED_PASSWORD_ADMIN Initial password for admin admin
PRE_SEED_PASSWORD_USER Initial password for user user
API_KEY API Key for communication with workers supersecret
DEBUG Debug logging False
DB_URL PostgreSQL database URL localhost
DB_DATABASE PostgreSQL database name taranis
DB_USER PostgreSQL database user taranis
DB_PASSWORD PostgreSQL database password supersecret
JWT_SECRET_KEY JWT token secret key. supersecret
TARANIS_CORE_SENTRY_DSN DSN address for Sentry; includes DB as well ''
TARANIS_BASE_PATH Path under which Taranis AI is reachable /

worker

Environment variable Description Default
TARANIS_CORE_URL URL of the Taranis AI core API '' *
TARANIS_BASE_PATH Path under which Taranis AI is reachable /
TARANIS_CORE_HOST* Hostname and Port of the Taranis AI core core:8080
API_KEY API Key for communication with core supersecret
QUEUE_BROKER_HOST RabbitMQ Host address rabbitmq
QUEUE_BROKER_USER RabbitMQ user taranis
QUEUE_BROKER_PASSWORD RabbitMQ password supersecret
DEBUG Debug logging False

Note

** If TARANIS_CORE_URL is not set it will be calculated as: http://{TARANIS_CORE_HOST}/{TARANIS_BASE_PATH}/api.

If you set TARANIS_CORE_URL: TARANIS_CORE_HOST and TARANIS_BASE_PATH will be ignored.

gui

Environment variable Description Default
TARANIS_CORE_API URL of the Taranis core API. /api/
TARANIS_CORE_UPSTREAM nginx upstream for the Taranis Core core:8080
TARANIS_GUI_SENTRY_DSN Sentry DSN ''
NGINX_WORKERS Number of nginx worker threads to spawn. 4
NGINX_CONNECTIONS Maximum number of connections per worker thread. 16
TARANIS_BASE_PATH Path under which Taranis AI is reachable /