Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crazy-max/docker-n8n
n8n Docker image
https://github.com/crazy-max/docker-n8n
alpine-linux docker docker-compose multi-platform n8n workflow-automation
Last synced: 19 days ago
JSON representation
n8n Docker image
- Host: GitHub
- URL: https://github.com/crazy-max/docker-n8n
- Owner: crazy-max
- License: mit
- Archived: true
- Created: 2021-04-05T02:44:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T18:20:12.000Z (5 months ago)
- Last Synced: 2024-06-22T07:51:34.510Z (3 months ago)
- Topics: alpine-linux, docker, docker-compose, multi-platform, n8n, workflow-automation
- Language: Dockerfile
- Homepage:
- Size: 73.2 KB
- Stars: 15
- Watchers: 3
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
## About
Docker image for [n8n](https://github.com/n8n-io/n8n), a workflow automation
tool. Easily automate tasks across different services.
> [!TIP]
> Want to be notified of new releases? Check out 🔔 [Diun (Docker Image Update Notifier)](https://github.com/crazy-max/diun)
> project!
___
* [Build locally](#build-locally)
* [Image](#image)
* [Environment variables](#environment-variables)
* [Ports](#ports)
* [Usage](#usage)
* [Upgrade](#upgrade)
* [Contributing](#contributing)
* [License](#license)
## Build locally
```shell
git clone https://github.com/crazy-max/docker-n8n.git
cd docker-n8n
# Build image and output to docker (default)
docker buildx bake
# Build multi-platform image
docker buildx bake image-all
```
## Image
| Registry | Image |
|--------------------------------------------------------------------------------------------------|---------------------------------|
| [Docker Hub](https://hub.docker.com/r/crazymax/n8n/) | `crazymax/n8n` |
| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/n8n) | `ghcr.io/crazy-max/n8n` |
Following platforms for this image are available:
```
$ docker run --rm mplatform/mquery crazymax/n8n:latest
Image: crazymax/n8n:latest
* Manifest List: Yes
* Supported platforms:
- linux/amd64
- linux/arm/v7
- linux/arm64
```
## Environment variables
* `TZ`: The timezone assigned to the container (default `UTC`)
To configure the application, just add the environment variables as shown in the official
[Configuration page](https://docs.n8n.io/reference/configuration.html) of n8n.
## Ports
* `5678`: HTTP port
## Usage
### Docker Compose
Docker compose is the recommended way to run this image. You can use the following
[docker compose template](examples/compose/compose.yml), then run the container:
```bash
docker compose up -d
docker compose logs -f
```
### Command line
You can also use the following minimal command:
```shell
docker run -d -p 5678:5678 --name n8n \
-e "TZ=Europe/Paris" \
-e "GENERIC_TIMEZONE=Europe/Paris" \
-v $(pwd)/data:/data \
crazymax/n8n:latest
```
## Upgrade
To upgrade, pull the newer image and launch the container :
```bash
docker compose pull
docker compose up -d
```
## Contributing
Want to contribute? Awesome! The most basic way to show your support is to star
the project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)
or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this
journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See `LICENSE` for more details.