Quickstart

Tangled is designed to run as a set of Docker containers for easy deployment and isolation.

Installation

1

Clone Repository

git clone https://github.com/ineesdv/Tangled.git
cd tangled

2

Configure Environment

Copy and edit the environment file (alternatively, run ./start.sh):

cp .env.example .env

Required variables:

# Database
DB_HOST=db
DB_PORT=5432
DB_NAME=tangled
DB_USER=tangled
DB_PASSWORD=<secure_password>

# Security
JWT_SECRET=<random_string>
FERNET_KEY=<generated_key>

# Admin Account
ADMIN_EMAIL=admin
ADMIN_PASSWORD=<admin_password>

# Environment
APP_ENV=production

You can generate your own secure FERNET_KEY and JWT_SECRET by running:

python3 -c "from cryptography.fernet import Fernet; print('Fernet key:', Fernet.generate_key().decode());"
python3 -c "import secrets; print('JWT Secret:', secrets.token_urlsafe(32));"

3

Start Services

docker-compose up -d

This starts three containers:

Service	Port	Description
Frontend	8080	Web interface (Nginx + React UI)
Backend	8000	REST API (FastAPI)
Database	5432	Database (PostgreSQL)

4

Access Tangled

Navigate to http://localhost:8080 and log in with your admin credentials.

5

Create a campaign

Configure and run your first campaign!

---

Backup & Restore

Campaign data, templates, and configurations are persisted in a Docker volume (pgdata). To backup your data you can simply run these commands:

Backup:

docker exec tangled_db pg_dump -U <DB_USER> <DB_PASS> > backup.sql

Restore:

docker exec -i tangled_db psql -U <DB_USER> <DB_PASS> < backup.sql