Skip to content

Commit

Permalink
add cloud section including best practices
Browse files Browse the repository at this point in the history
  • Loading branch information
StarfallProjects committed Feb 5, 2024
1 parent fad4852 commit 9fbb65a
Show file tree
Hide file tree
Showing 11 changed files with 106 additions and 81 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
The node relies on the timezone setting. n8n uses either:

1. The workflow timezone, if set. Refer to [Workflow settings](/workflows/settings/) for more information.
2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/environment-variables/environment-variables/#timezone-and-localization). Cloud admins can change the instance timezone in the [Admin dashboard](/cloud-admin-dashboard/).
2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/environment-variables/environment-variables/#timezone-and-localization). Cloud admins can change the instance timezone in the [Admin dashboard](/manage-cloud/set-cloud-timezone/).
///
10 changes: 7 additions & 3 deletions docs/_redirects
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

/choose-n8n/cloud/ /manage-cloud/
/cloud-admin-dashboard/ /manage-cloud/cloud-admin-dashboard/

/langchain/access-langchain/ /langchain/

/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorychatretriever/ /integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymanager/
Expand Down Expand Up @@ -114,14 +118,14 @@
# Hosting user paths 2022

/hosting/options/ /choose-n8n/
/hosting/installation/cloud/ /choose-n8n/cloud/
/hosting/installation/cloud/ /manage-cloud/
/hosting/installation/desktop-app/ /choose-n8n/
/hosting/server-setups/* /hosting/installation/server-setups/:splat
/hosting/environment-variables/ /hosting/environment-variables/environment-variables/
/hosting/updating/ /reference/update/
/hosting/updating/cloud/ /choose-n8n/cloud/
/hosting/updating/cloud/ /manage-cloud/update-cloud-version/
/hosting/updating/desktop/ /choose-n8n/
/hosting/updating/npm/ /choose-n8n/npm/
/hosting/updating/npm/ /hosting/installation/npm/
/hosting/databases/supported-databases-settings/ /hosting/supported-databases-settings/
/hosting/databases/structure/ /hosting/architecture/database-structure/
/hosting/security/ /hosting/user-management/
Expand Down
File renamed without changes.
37 changes: 0 additions & 37 deletions docs/choose-n8n/cloud.md

This file was deleted.

36 changes: 0 additions & 36 deletions docs/cloud-admin-dashboard.md

This file was deleted.

17 changes: 17 additions & 0 deletions docs/manage-cloud/cloud-admin-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
description: How to access the Cloud admin dashboard.
contentType: howto
---

# Cloud admin dashboard

Instance owners can access the admin dashboard to manage their Cloud instance. This is where you can upgrade your n8n version and set the timezone.

## Access the dashboard from the app

1. [Log in to n8n](https://app.n8n.cloud/login){:target=_blank .external-link}
1. Select **Admin Dashboard**. n8n opens the dashboard.

## Access the dashboard if the app is offline

If your instance is down, you can still access the admin dashboard. When you log in to the app, n8n will ask you if you want a magic link to access your dashboard. Select **Send magic link**, then check your email for the link.
18 changes: 18 additions & 0 deletions docs/manage-cloud/cloud-ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
contentType: reference
---

# Cloud IP addresses

/// warning | Cloud IP addresses change without warning
n8n can't guarantee static source IPs, as Cloud operates in a dynamic cloud provider environment and scales its infrastructure to meet demand. You should use strong authentication and secure transport protocols when connecting into and out of n8n.
///

Outbound traffic may appear to originate from any of:

* 20.79.227.226
* 20.79.72.36
* 20.113.47.122
* 20.218.202.73
* 20.79.232.36
* 20.79.192.145
23 changes: 23 additions & 0 deletions docs/manage-cloud/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
contentType: overview
---

# n8n Cloud

n8n Cloud is n8n's hosted solution. It provides:

- No technical set up or maintenance for your n8n instance
- Continual uptime monitoring
- Managed OAuth for authentication
- One-click upgrades to the newest n8n versions

[Sign up for n8n Cloud](https://www.n8n.cloud/){:target=_blank .external-link}

/// note | Russia and Belarus
n8n Cloud isn't available in Russia and Belarus. Refer to this blog post: [Update on n8n cloud accounts in Russia and Belarus](https://n8n.io/blog/update-on-n8n-cloud-accounts-in-russia-and-belarus/) for more information.
///





11 changes: 11 additions & 0 deletions docs/manage-cloud/set-cloud-timezone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
description: How to set your timezone on n8n Cloud.
contentType: howto
---

# Set the Cloud instance timezone

You can change the timezone for your n8n instance. This affects the [Schedule Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/) and [Date & Time node](/integrations/builtin/core-nodes/n8n-nodes-base.datetime/). Users can configure the timezone for individual workflows in [Workflow settings](/workflows/settings/).

1. On your dashboard, select **Manage**.
1. Change the **Timezone** dropdown to the timezone you want.
22 changes: 22 additions & 0 deletions docs/manage-cloud/update-cloud-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
description: How to update your n8n version on Cloud.
contentType: howto
---

# Update your Cloud version

n8n recommends regularly updating your Cloud version. Check the [Release notes](/release-notes/) to learn more about changes.

Check warning on line 8 in docs/manage-cloud/update-cloud-version.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/manage-cloud/update-cloud-version.md#L8

[from-microsoft.Adverbs] Consider removing 'regularly'.
Raw output
{"message": "[from-microsoft.Adverbs] Consider removing 'regularly'.", "location": {"path": "docs/manage-cloud/update-cloud-version.md", "range": {"start": {"line": 8, "column": 16}}}, "severity": "WARNING"}

Check warning on line 8 in docs/manage-cloud/update-cloud-version.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/manage-cloud/update-cloud-version.md#L8

[from-write-good.Weasel] 'regularly' is a weasel word!
Raw output
{"message": "[from-write-good.Weasel] 'regularly' is a weasel word!", "location": {"path": "docs/manage-cloud/update-cloud-version.md", "range": {"start": {"line": 8, "column": 16}}}, "severity": "WARNING"}

1. On your dashboard, select **Manage**.
1. Use the **n8n version** dropdown to select your preferred release version:
* Latest Stable: recommended for most users.
* Latest Beta: get the newest n8n. This may be unstable.
1. Select **Save Changes** to restart your n8n instance and perform the update.
1. In the confirmation modal, select **Confirm**.


## Best practices for updating

* Update frequently: this avoids having to jump multiple versions at once, reducing the risk of a disruptive update.
* Check the [Release notes](/release-notes/) for breaking changes.
* Use [Environments](/source-control-environments/) to create a test version of your instance. Test the update there first.
11 changes: 7 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,11 @@ plugins:
nav:
- Using n8n:
- Welcome: index.md
- Choose your n8n: choose-n8n.md
- Try it out:
- try-it-out/index.md
- A very quick quickstart: try-it-out/quickstart.md
- A longer introduction: try-it-out/longer-introduction.md
- Choose your n8n:
- choose-n8n/index.md
- Cloud: choose-n8n/cloud.md
- Faircode license: choose-n8n/faircode-license.md
- Understand workflows:
- workflows/index.md
Expand Down Expand Up @@ -238,6 +236,12 @@ nav:
- Okta Workforce Identity SAML setup: user-management/saml/okta.md
- Troubleshooting: user-management/saml/troubleshooting.md
- Manage users with SAML: user-management/saml/managing.md
- Manage n8n Cloud:
- manage-cloud/index.md
- Acces the Cloud admin dashboard: manage-cloud/cloud-admin-dashboard.md
- Update your n8n Cloud version: manage-cloud/update-cloud-version.md
- Set the timezone: manage-cloud/set-cloud-timezone.md
- Cloud IP addresses: manage-cloud/cloud-ip.md
- Source control and environments:
- source-control-environments/index.md
- Understand:
Expand All @@ -259,7 +263,6 @@ nav:
- "Tutorial: Build an AI workflow in n8n": langchain/langchain-tutorial.md
- LangChain learning resources: langchain/learning-resources.md
- Langchain concepts in n8n: langchain/langchain-n8n.md
- Cloud admin dashboard: cloud-admin-dashboard.md
- Privacy and security:
- privacy-security/index.md
- Privacy: privacy-security/privacy.md
Expand Down

0 comments on commit 9fbb65a

Please sign in to comment.