docs: Update docker readme #13268
docs: Update docker readme #13268
Conversation
|
|
There was a problem hiding this comment.
@evilnick Left a few small suggestions, but looks good 👍 Thanks for working on updating this!
|
|
||
| ## Available integrations | ||
|
|
||
| n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes) | ||
| n8n has 200+ different nodes to automate workflows. A full list can be found at [https://n8n.io/nodes](https://n8n.io/nodes). |
There was a problem hiding this comment.
| n8n has 200+ different nodes to automate workflows. A full list can be found at [https://n8n.io/nodes](https://n8n.io/nodes). | |
| n8n has 200+ different nodes to automate workflows. A full list can be found at [https://n8n.io/integrations](https://n8n.io/integrations). |
Looks like the old link redirects here.
| docker.n8n.io/n8nio/n8n | ||
| ``` | ||
|
|
||
| This command will download all required n8n images and start your container. |
There was a problem hiding this comment.
This might be a bit confusing since this is only a single image. What do you think?
|
|
||
| To use it simply start n8n with `--tunnel` | ||
|
|
||
| ```bash | ||
| docker volume create n8n_data |
There was a problem hiding this comment.
It's nice that this command is idempotent. I didn't know that!
| for the credentials. If none gets found n8n creates automatically one on | ||
| startup. In case credentials are already saved with a different encryption key | ||
| it can not be used anymore as encrypting it is not possible anymore. | ||
| Note that even when using a different database, it is still important to |
There was a problem hiding this comment.
It might be worth using the same convention here that we use for the warning above (quoted, with a bolded label). I could see people missing this on a skim.
| #### Use with PostgresDB | ||
|
|
||
| Replace the following placeholders with the actual data: | ||
| In the following commands, replace these placeholders with the actual data: | ||
|
|
||
| - POSTGRES_DATABASE |
There was a problem hiding this comment.
This might be a strange question, but do you think we should include the angle brackets in the listing here? Not a big deal either way, just wondering which is easier to interpret.
| docker stop [container_id] | ||
| ``` | ||
|
|
||
| 3. Remove the container with ID container_id: |
There was a problem hiding this comment.
For peace of mind, it might be good to keep the note that this only deletes the container, not your data.
| - [Pull specific version](#pull-specific-version) | ||
| - [Pull next (unstable) version](#pull-next-unstable-version) | ||
| - [Updating with Docker Compose](#updating-with-docker-compose) | ||
| - [Setting Timezone](#setting-timezone) |
There was a problem hiding this comment.
| - [Setting Timezone](#setting-timezone) | |
| - [Setting Timezone](#setting-the-timezone) |
| ## Setting the timezone | ||
|
|
||
| To specify the timezone n8n should use, the environment variable `GENERIC_TIMEZONE` can | ||
| be set. One instance where this variable is implemented is in the Schedule node. |
There was a problem hiding this comment.
| be set. One instance where this variable is implemented is in the Schedule node. | |
| be set. One place this variable affects is the Schedule node. |
Maybe something like this? I know you didn't write this, but I think "instance" can be overloaded in hosting contexts and "implemented" also feels like it's not the most accurate verb.
Summary
N.B. The intention is to also use this for the readme on hub.docker.com
Related Linear tickets, Github issues, and Community forum posts
internal request
Review / Merge checklist