Installing NocoDB Enterprise with Docker Compose

Docker Compose allows you to define and run multi-container Docker applications. It's a great way to set up NocoDB along with all resources in a single configuration file.

Prerequisites

• Docker
• Docker Compose

Installation Steps

1. Clone the NocoDB repository from GitHub or get the template files from the links below Template Files.

   git clone /~https://github.com/nocodb/nocodb-ee-compose

Tip

If you are using the template files, download them to a directory on your host machine.
Structure the directory as following:
├── docker-compose.yml
├── docker.env
├── nocodb
........└── db.json

2. Navigate to the cloned directory:

   cd nocodb-ee-compose

3. Replace & configure the placeholder values in the docker-compose.yml, docker.env and nocodb/db.json files.

Tip

You can use a text editor to search and replace the placeholder values in the files.
List of placeholder values to replace:

• {{PLACEHOLDER_NC_LICENSE_KEY}}
• {{PLACEHOLDER_NOCODB_DOMAIN}}
• {{PLACEHOLDER_MINIO_DOMAIN}}
• {{PLACEHOLDER_MINIO_ROOT_PASSWORD}}
• {{PLACEHOLDER_PG_USER}}
• {{PLACEHOLDER_PG_PASSWORD}}

4. Start the services using Docker Compose:

   docker-compose up -d

   This will start NocoDB along with a PostgreSQL database, MinIO, and Redis.

5. Access NocoDB in your browser by visiting https://your-domain.tld.

Template Files

• docker-compose.yml - The main Docker Compose configuration file (get).
• docker.env - Environment variables for the NocoDB service (get).
• db.json - Database configuration file for NocoDB (get).

Troubleshooting

• If you encounter any issues, check the logs using the following command:

  docker-compose logs

• If you need to stop the services, use the following command:

  docker-compose down

• Ensure all required ports are available on your host machine (80, 443)