Skip to main content

Running with Docker

This guide will help you quickly set up and run Endatix using Docker containers for development and testing purposes. The setup script handles everything automatically - just run it and you're ready to go.

warning

Important: This is a development setup not suitable for production use. It uses HTTP (not HTTPS), default passwords, and simplified configuration. For production deployments, please contact Endatix for guidance on secure, scalable setups.

What is Endatix?​

Endatix is a modern platform for creating and managing SurveyJS based forms and surveys. It consists of:

  • Endatix API: Backend service for form management and data collection
  • Endatix Hub: Web interface for creating forms and viewing responses

Prerequisites​

Before proceeding, ensure you have installed:

  • Docker Desktop (includes Docker and Docker Compose)

Download from: https://docs.docker.com/get-docker/

Tested with Docker version 28.3.2 and Docker Compose v2.38.2.

Quick Start​

Step 1: Get Setup Files​

You need these files to get Endatix running:

  • setup.bat (Windows) or setup.sh (Linux/macOS)
  • docker-compose.yaml

Option A: Direct Download

Option B: Using Command Line

Windows (PowerShell/Command Prompt):

curl -o setup.bat https://raw.githubusercontent.com/endatix/endatix/main/docker/setup.bat
curl -o docker-compose.yaml https://raw.githubusercontent.com/endatix/endatix/main/docker/docker-compose.yaml

Linux/macOS (Terminal):

curl -o setup.sh https://raw.githubusercontent.com/endatix/endatix/main/docker/setup.sh
curl -o docker-compose.yaml https://raw.githubusercontent.com/endatix/endatix/main/docker/docker-compose.yaml

Step 2: Check Port Availability​

Make sure these ports are free on your machine:

  • 8080 - Endatix API
  • 3000 - Endatix Hub

Step 3: Run the Setup Script​

Windows: Double-click setup.bat or run in Command Prompt/PowerShell:

setup.bat

Linux/macOS: First make executable, then run:

chmod +x setup.sh
./setup.sh

Step 4: Enter Admin Credentials​

The script will prompt you for:

  • Admin Email: Default is admin@endatix.com
  • Admin Password: Default is P@ssw0rd
info

Note: For testing purposes, you can use the defaults. Change these credentials before any production use.

Press Enter to use defaults, or type your own values.

The script will automatically:

  1. Download the required Docker images
  2. Create and start all containers
  3. Set up the database and initial admin user

Access Your Endatix Platform​

Once setup is complete, open your browser and visit:

Sign in using the admin credentials you set during setup.

warning

Security Note: This setup uses HTTP connections for simplicity. Production environments require HTTPS, secure passwords, and additional security measures.

Managing Containers​

Stop containers:

docker compose -f docker-compose.yaml stop

Start containers again:

docker compose -f docker-compose.yaml start

Remove containers (keeps data):

docker compose -f docker-compose.yaml down

View logs:

docker compose -f docker-compose.yaml logs

Troubleshooting​

If you encounter issues:

  1. Ensure Docker Desktop is running
  2. Check that required ports (8080, 3000) are available
  3. Review the setup script output for error messages

For support, visit endatix.com or GitHub Discussions.

For production deployments, contact Endatix for guidance on secure, scalable setups with HTTPS, proper authentication, monitoring, and backup strategies.

That's it! 🚀 Your Endatix Platform is ready for exploring.