Skip to main content

Installing Zango with Docker

Run the entire Zango stack — including PostgreSQL, Redis, and the app server — as Docker services. No separate service installation needed.

Pre-requisites

Ensure that Docker and Docker Compose are installed on your machine. If not, follow the installation instructions for Docker and Docker Compose.


Steps

1. Clone the Zango repository

git clone https://github.com/Healthlane-Technologies/zango.git
cd zango

2. Run the setup script from the root folder

python setup_project.py --project_dir <directory>

You can use the --build_core option to build the Zango library. This creates a project named zango_project in the zproject folder in the specified directory.


3. Customize the project creation using optional arguments

python setup_project.py --project_name my_project --project_dir /path/to/my_project --build_core --platform_username user@example.com --platform_user_password secret --skip_build_project
ArgumentDescriptionDefault
--project_nameName of the projectzango_project
--project_dirDirectory for project creationzproject
--build_coreBuilds the Zango libraryFalse
--platform_usernamePlatform user emailplatform_admin@zango.dev
--platform_user_passwordPlatform user passwordZango@123

4. Navigate to project_dir to start the project


5. Export the host UID and GID

Docker runs as a non-root user. Run these commands to export the host UID and GID:

export HOST_UID=$(id -u)
export HOST_GID=$(id -g)

6. Start the project

docker compose up

After starting, wait a minute or two for all services to be fully up and running.

What's included in the Docker Compose setup

The Zango Docker Compose configuration brings up the full stack automatically — PostgreSQL, Redis, the Zango app server, Celery worker, and Celery beat. You do not need to install or start any of these services separately.


Access the platform

Once ready, open your browser at:

http://localhost:8000/platform

Use the default credentials below, or the credentials you specified when running setup_project.py:

Default credentials

Username:platform_admin@zango.dev
Password:Zango@123

Next step

With the platform running, create your first Zango project.



Create a Zango project →