Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/code-quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,6 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Create volume directories
run: bash scripts/setup_volumes.sh
- name: Copy .env file
run: cp .env.example .env
- name: Set up Docker Buildx
Expand Down
37 changes: 16 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,6 @@ This project uses custom Docker images built from the following Dockerfiles:

## Usage

### Prepare volume directories

Before starting the services, run the setup script to create the necessary volume directories:

```bash
./scripts/setup_volumes.sh
```

This prevents volume mount errors that may occur if the directories don't exist.

### Create environment file

Create a `.env` file in the root directory of the project with your environment variables:
Expand All @@ -44,11 +34,19 @@ Then edit the `.env` file to set your specific configuration values.

### Starting the services

You can start the services in two ways, depending on your environment:

#### 1. Development

```bash
docker compose up -d
```

This will start all services in detached mode.
#### 2. Production

```bash
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d
```

### Building custom images

Expand Down Expand Up @@ -138,11 +136,14 @@ docker compose down -v

## Data Persistence

All data is stored in local volumes under the `./volumes/` directory:
Data for all services is persisted using Docker volumes. The storage location depends on the environment:

- **Development (default, using `docker-compose.yml`)**: Docker uses anonymous volumes for each service. These are managed by Docker and are not bound to any directory in your project. Data persists as long as the volume exists, but is not directly accessible from the project folder.

- `./volumes/n8n_data` - n8n data and workflows
- `./volumes/opensearch-data` - OpenSearch data for Temporal
- `./volumes/postgresql-data` - PostgreSQL database for Temporal
- **Production (using `docker-compose.prod.yml`)**: Volumes are explicitly bound to host directories under `/data/` for persistent storage and easier backup/restore.

> **Note:**
> - Removing volumes with `docker compose down -v` will delete all persisted data.

## Service Ports

Expand All @@ -166,12 +167,6 @@ If you encounter any issues:

3. Make sure Docker has sufficient resources allocated

4. If you encounter volume mount errors (e.g., "failed to mount local volume ... no such file or directory"), run the setup script:
```bash
./scripts/setup_volumes.sh
```
This creates the necessary volume directories in the `./volumes/` folder.

## GitHub MCP Configuration

To use GitHub-related functions with Cursor's Machine Coding Protocol (MCP), you need to configure a GitHub Personal Access Token:
Expand Down
19 changes: 19 additions & 0 deletions docker-compose.prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
volumes:
n8n_data:
driver: local
driver_opts:
type: none
o: bind
device: /data/n8n
opensearch-data:
driver: local
driver_opts:
type: none
o: bind
device: /data/opensearch
postgresql-data:
driver: local
driver_opts:
type: none
o: bind
device: /data/postgresql
15 changes: 0 additions & 15 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -129,23 +129,8 @@ services:

volumes:
n8n_data:
driver: local
driver_opts:
type: none
o: bind
device: ${PWD}/volumes/n8n_data
opensearch-data:
driver: local
driver_opts:
type: none
o: bind
device: ${PWD}/volumes/opensearch-data
postgresql-data:
driver: local
driver_opts:
type: none
o: bind
device: ${PWD}/volumes/postgresql-data

networks:
app-network:
Expand Down
15 changes: 0 additions & 15 deletions scripts/setup_volumes.sh

This file was deleted.