Skip to content

Commit 2d4a465

Browse files
committed
update reason for volumes
1 parent 1695094 commit 2d4a465

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

samples/n8n/README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![1-click-deploy](https://raw.githubusercontent.com/DefangLabs/defang-assets/main/Logos/Buttons/SVG/deploy-with-defang.svg)](ASK RAPH)
44

5-
This sample shows how to get a [n8n](https://n8n.io/) app up using PostgreSQL as a database and running with Defang. The original sample can be found [here](https://github.com/n8n-io/n8n-hosting/tree/main/docker-compose/withPostgres). The official n8n guide for setting up with PostgreSQL [here](https://docs.n8n.io/hosting/installation/server-setups/docker-compose/) does not work with Defang. To use the version compatible with Defang, please refer to this sample instead.
5+
This sample shows how to get a [n8n](https://n8n.io/) app up using PostgreSQL as a database and running with Defang. The original sample can be found [here](https://github.com/n8n-io/n8n-hosting/tree/main/docker-compose/withPostgres). The official n8n guide for setting up with PostgreSQL [here](https://docs.n8n.io/hosting/installation/server-setups/docker-compose/) does not work with Defang. The reason the sample does not work is because it relies on certain Docker features that are not supported by Defang, which are volumes. To use the version compatible with Defang, please refer to this sample instead.
6+
7+
This sample demonstrates how to run an [n8n](https://n8n.io/) app with PostgreSQL as the database using Defang. The original sample can be found [here](https://github.com/n8n-io/n8n-hosting/tree/main/docker-compose/withPostgres). However, the official n8n [guide](https://docs.n8n.io/hosting/installation/server-setups/docker-compose/) for setting up with PostgreSQL is not compatible with Defang. The incompatibility comes from its reliance on Docker volumes feature not supported by Defang. To use a version that works with Defang, please refer to this sample instead.
68

79
## Prerequisites
810

@@ -12,8 +14,6 @@ This sample shows how to get a [n8n](https://n8n.io/) app up using PostgreSQL as
1214

1315
## Development
1416

15-
**IMPORTANT:** But before you do that change the default users and passwords in the [`.env`](.env) file!
16-
1717
To run the application locally for development, use the development compose file:
1818

1919
```bash
@@ -57,8 +57,8 @@ The POSTGRES_NON_ROOT_USER's password for your Postgres database, it will be use
5757

5858
The project includes two compose files:
5959

60-
- **`compose.dev.yaml`** - For local development with volume persistence and port exposure
61-
- **`compose.yaml`** - For cloud deployment (extends `compose.dev.yaml` with cloud-specific optimizations)
60+
- **`compose.dev.yaml`** - For local development with volume persistence
61+
- **`compose.yaml`** - For cloud deployment with Defang
6262

6363
> [!NOTE]
6464
> Download [Defang CLI](https://github.com/DefangLabs/defang)
@@ -71,13 +71,6 @@ Deploy your application to the Defang Playground by opening up your terminal and
7171
defang compose up
7272
```
7373

74-
This will use `compose.yaml` which extends `compose.dev.yaml` but:
75-
76-
- Removes volume mounts (not supported by Defang)
77-
- Removes PostgreSQL port exposure for security
78-
- Adds a `setup` service to initialize the database with proper user permissions
79-
- Optimizes environment variables for cloud deployment
80-
8174
### BYOC (AWS)
8275

8376
If you want to deploy to your own cloud account, you can use Defang BYOC:

0 commit comments

Comments
 (0)