Skip to content

Port existing Cloud docs content from v4 website to Strapi 5 website — July 2024 update #2154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 24, 2024
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
92 changes: 41 additions & 51 deletions docusaurus/docs/cloud/account/account-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,80 +13,70 @@ tags:
---

import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
import InvoiceStatus from '/docs/snippets/invoices-statuses.md'

# Account billing details
# Account billing & invoices

<NotV5/>
<NotV5 />

Through the *Profile* page, accessible by clicking on your profile picture on the top right hand corner of the interface then clicking on **Profile**, you can access the *Billing* tab.
Through the *Profile* page, accessible by clicking on your profile picture on the top right hand corner of the interface then clicking on **Profile**, you can access the [![Billing icon](/img/assets/icons/CreditCard.svg) *Billing*](#account-billing) and [![Invoices icon](/img/assets/icons/Invoice.svg) *Invoices*](#account-invoices) tabs.

The *Billing* tab displays and enables you to modify the billing details and payment method set for the account. This information will by default be reused for every new project created with your Strapi Cloud account.
## Account billing

:::note
The Payment method section can only be accessible once the mandatory fields of the Billing details section have been filled in.
:::
The ![Billing icon](/img/assets/icons/CreditCard.svg) *Billing* tab displays and enables you to modify the billing details and payment method set for the account.

<ThemedImage
alt="Billing tab of Profile page"
sources={{
light: '/img/assets/cloud/account-billing2.png',
dark: '/img/assets/cloud/account-billing2_DARK.png',
}}
light: '/img/assets/cloud/account-billing2.png',
dark: '/img/assets/cloud/account-billing2_DARK.png',
}}
/>

## Managing subscriptions
The *Payment method* section of the ![Billing icon](/img/assets/icons/CreditCard.svg) *Billing* tab allows you to manage the credit cards that can be used for the Strapi Cloud projects. The *Billing details* section requires to be filled in, at least for the mandatory fields, as this information will be the default billing details for all Strapi Cloud projects related to your account.

Using the **Manage subscriptions** button, you can view and manage your subscriptions, account and billing information, and payment method.
### Adding a new credit card

1. Click the **Manage subscriptions** button. A login modal will appear.
1. In the *Payment method* section of the ![Billing icon](/img/assets/icons/CreditCard.svg) *Billing* tab, click on the **Add card** button.
2. Fill in the following fields:

2. Enter the billing email address associated with your account and click **Continue**. A one-time password will be sent to the email address.
| Field name | Description |
| --- | --- |
| Card Number | Write the number of the credit card to add as payment method. |
| Expires | Write the expiration date of the credit card. |
| CVC | Write the 3-numbers code displayed at the back of the credit card. |

3. Enter the one-time password and click **Continue**. The **Manage Subscriptions** modal will appear. From here, you can:

- view and edit your subscriptions by clicking on the active subscription(s) tile(s): change project name, update shipping details, [edit current subscription](#edit-subscription) and [cancel current subscription](#cancel-subscription)
- view and edit your Account Information: email, password, company name
- view and edit your Billing & Shipping Addresses
- view and edit your Payment Methods and add new ones
- access your Billing History and download your invoices
3. Click on the **Save** button.

<ThemedImage
alt="Subscriptions management modal"
sources={{
light: '/img/assets/cloud/manage-subscriptions.png',
dark: '/img/assets/cloud/manage-subscriptions_DARK.png',
}}
/>
:::tip
The first credit card to be added as payment method for the account will by default be the primary one. It is however possible to define another credit card as primary by clicking on the ![Menu icon](/img/assets/icons/more.svg) icon, then **Switch as primary**.
:::

## Edit subscription
### Deleting a credit card

From the subscription management modal, you can view and modify any current subscription.
To remove a credit card from the list of payment methods for the account:

<ThemedImage
alt="Subscription edition modal"
sources={{
light: '/img/assets/cloud/edit-subscription-modal.png',
dark: '/img/assets/cloud/edit-subscription-modal_DARK.png',
}}
/>
1. Click on the ![Menu icon](/img/assets/icons/more.svg) icon of the credit card you wish to delete.
2. Click **Remove card**. The card is immediately deleted.

:::note
You cannot delete the primary card as at least one credit card must be available as payment method, and the primary card is by default that one. If the credit card you wish to delete is currently the primary card, you must first define another credit card as primary, then delete it.
:::

1. Click on an active subscription tile (e.g. "Strapi Cloud Pro $99.00" located above the subscriptions management links such as *Account Information*, *Billing & Shipping Addresses*). You will be redirected to your subscription details.
2. Click on the **Edit Subscription** link.
3. If you only want to add addons (e.g. additional seats), click on the **Add Addons** button.
4. If you want to change plan (e.g. from Pro plan to Team plan), click on **Change** and select a new plan.
5. Confirm your modifications by clicking on the **Update Subscription** button at the bottom of the modal.
## Account invoices

## Cancel subscription
The ![Invoices icon](/img/assets/icons/Invoice.svg) *Invoices* tab displays the complete list of invoices for all your Strapi Cloud projects.

<ThemedImage
alt="Subscription cancellation modal"
alt="Invoices tab of Profile page"
sources={{
light: '/img/assets/cloud/cancel-subscription-modal.png',
dark: '/img/assets/cloud/cancel-subscription-modal_DARK.png',
}}
light: '/img/assets/cloud/account-invoices.png',
dark: '/img/assets/cloud/account-invoices_DARK.png',
}}
/>

1. Click on an active subscription tile (e.g. "Strapi Cloud Pro $99.OO"). You will be redirected to your subscription details.
2. Click on the **Cancel Subscription** link.
3. Select the reason of your cancellation from the drop-down menu, and optionally add a comment in the textbox.
4. Confirm your choice by clicking on the **Confirm Cancellation** button.
<InvoiceStatus components={props.components} />

:::strapi Invoices are also available per project.
In the *Settings > Invoices* tab of any project, you will find the invoices for that project only. Feel free to check the [dedicated documentation](/cloud/projects/settings#invoices).
:::
10 changes: 5 additions & 5 deletions docusaurus/docs/cloud/account/account-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ import NotV5 from '/docs/snippets/_not-updated-to-v5.md'

# Profile settings

<NotV5/>
<NotV5 />

The *Profile* page enables you to manage your account details and preferences. It is accessible by clicking on your profile picture, on the top right hand corner of the interface, and **Profile**.

There are 3 tabs available in the *Profile* interface: [*General*](#general), [*Preferences*](#preferences) and *Billing* (the latter is documented in the [Account billing details](/cloud/account/account-billing) section of this documentation).
There are 3 tabs available in the *Profile* interface: ![General icon](/img/assets/icons/Faders.svg) [*General*](#general), ![Preferences icon](/img/assets/icons/Palette.svg) [*Preferences*](#preferences), ![Billing icon](/img/assets/icons/CreditCard.svg) *Billing* and ![Invoices icon](/img/assets/icons/Invoice.svg) Invoices (the last 2 are documented in the [Account billing details](/cloud/account/account-billing) section of this documentation).

## General

The *General* tab enables you to edit the following details for your account profile:
The ![General icon](/img/assets/icons/Faders.svg) *General* tab enables you to edit the following details for your account profile:

- Details: to see the name associated with your account.
- Connected accounts: to manage Google, GitHub and GitLab accounts connected with your Strapi Cloud account (see [Managing connected accounts](#managing-connected-accounts)).
Expand All @@ -50,13 +50,13 @@ You can also click on the three dots button of a connected account and click on

You can delete your Strapi Cloud account, but it will be permanent and irreversible. All associated projects and their data will be deleted as well and the subscriptions for the projects will automatically be canceled.

1. In the *Delete account* section of the *General* tab, click on the **Delete account** button.
1. In the *Delete account* section of the ![General icon](/img/assets/icons/Faders.svg) *General* tab, click on the **Delete account** button.
2. In the dialog, type `DELETE` in the textbox.
3. Confirm the deletion of your account by clicking on the **Delete** button.

## Preferences

The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.
The ![Preferences icon](/img/assets/icons/Palette.svg) *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.

<ThemedImage
alt="Preferences tab of Profile page"
Expand Down
12 changes: 8 additions & 4 deletions docusaurus/docs/cloud/advanced/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,20 @@ import NotV5 from '/docs/snippets/_not-updated-to-v5.md'

Strapi Cloud provides a pre-configured PostgreSQL database by default. However, you can also configure it to utilize an external SQL database, if needed.

:::caution
While possible, it is not recommended to use an external database with Strapi Cloud, unless there is an explicit need to do so. This is because Strapi Cloud provides a managed database that is optimized for Strapi. Using an external database may result in unexpected behavior and/or performance issues (e.g., network latency may impact performance). Strapi cannot provide security or support with configuring external databases.
:::

:::prerequisites
- A local Strapi project running on `v4.8.2+`.
- Credentials for external database.
- If using an existing database, the schema must match the Strapi project schema.
:::

:::caution
While it's possible to use an external database with Strapi Cloud, you should do it while keeping in mind the following considerations:
- Strapi Cloud already provides a managed database that is optimized for Strapi.
- Using an external database may result in unexpected behavior and/or performance issues (e.g., network latency may impact performance). For performance reasons, it's recommended to host your external database close to the region where your Strapi Cloud project is hosted. You can find where your Strapi Cloud project is hosted in your Project Settings (see [Project Settings > General > Selected Region](/cloud/projects/settings#general)).
- Strapi can't provide security or support with external databases used with Strapi Cloud.
:::


## Configuration

The project `./config/database.js` or `./config/database.ts` file must match the configuration found in the [environment variables in database configurations](https://docs.strapi.io/dev-docs/configurations/database#environment-variables-in-database-configurations) section.
Expand Down
96 changes: 96 additions & 0 deletions docusaurus/docs/cloud/cli/cloud-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
sidebar_label: 'Cloud CLI'
displayed_sidebar: cloudSidebar
sidebar_position: 3
tags:
- Strapi Cloud
- CLI
- deployment
---

import NotV5 from '/docs/snippets/_not-updated-to-v5.md'

# Command Line Interface (CLI) <NewBadge />

<NotV5 />

Strapi Cloud comes with a Command Line Interface (CLI) which allows you to log in and out, and to deploy a local project without it having to be hosted on a remote git repository. The CLI works with both the `yarn` and `npm` package managers.

:::note
It is recommended to install Strapi locally only, which requires prefixing all of the following `strapi` commands with the package manager used for the project setup (e.g `npm run strapi help` or `yarn strapi help`) or a dedicated node package executor (e.g. `npx strapi help`).
:::

## strapi login

**Alias:** `strapi cloud:login`

Log in Strapi Cloud.

```bash
strapi login
```

This command automatically opens a browser window to first ask you to confirm that the codes displayed in both the browser window and the terminal are the same. Then you will be able to log into Strapi Cloud via Google, GitHub or GitLab. Once the browser window confirms successful login, it can be safely closed.

If the browser window doesn't automatically open, the terminal will display a clickable link as well as the code to enter manually.

## strapi deploy

**Alias:** `strapi cloud:deploy`

Deploy a new local project (< 100MB) in Strapi Cloud.

```bash
strapi deploy
```

This command must be used after the `login` one. It deploys a local Strapi project on Strapi Cloud, without having to host it on a remote git repository beforehand. The terminal will inform you when the project is successfully deployed on Strapi Cloud.

Once the project is first deployed on Strapi Cloud with the CLI, the `deploy` command can be reused to trigger a new deployment of the same project.

:::caution
The `deploy` command can only be used by new users who have never created a Strapi Cloud project, and for which the free trial is still available. Once a project is deployed with the CLI, it isn't possible to deploy another project on the same Strapi Cloud account with the CLI.
:::

:::note
Once you deployed your project, if you visit the Strapi Cloud dashboard, you may see some limitations as well as impacts due to creating a Strapi Cloud project that is not in a remote repository and which was deployed with the CLI.

- Some areas in the dashboard that are usually reserved to display information about the git provider will be blank.
- Some buttons, such as the **Trigger deploy** button, will be greyed out and unclickable since, unless you have [connected a git repository to your Strapi Cloud project](/cloud/getting-started/deployment-cli#automatically-deploying-subsequent-changes).
:::

## strapi link <NewBadge />

**Alias:** `strapi cloud:link`

Links project in current folder to an existing project in Strapi Cloud.

```bash
strapi link
```

This command connects your local project in the current directory with an existing project on your Strapi Cloud account. You will be prompted to select the project you wish to link from a list of available projects hosted on Strapi Cloud.

## strapi projects <NewBadge />

**Alias:** `strapi cloud:projects`

Lists all Strapi Cloud projects associated with your account.

```bash
strapi projects
```

This command retrieves and displays a list of all projects hosted on your Strapi Cloud account.

## strapi logout

**Alias:** `strapi cloud:logout`

Log out of Strapi Cloud.

```bash
strapi logout
```

This command logs you out of Strapi Cloud. Once the `logout` command is run, a browser page will open and the terminal will display a confirmation message that you were successfully logged out. You will not be able to use the `deploy` command anymore.
23 changes: 23 additions & 0 deletions docusaurus/docs/cloud/getting-started/cloud-fundamentals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_label: 'Cloud fundamentals'
displayed_sidebar: cloudSidebar
slug: /cloud/cloud-fundamentals
sidebar_position: 1
tags:
- Strapi Cloud
- concepts
---

# Strapi Cloud fundamentals

Before going any further into this Strapi Cloud documentation, we recommend you to acknowledge the main concepts below. They will help you to understand how Strapi Cloud works, and ensure a smooth Strapi Cloud experience.

- **Hosting Platform** <br/> Strapi Cloud is a hosting platform that allows to deploy already existing Strapi projects created with Strapi CMS (Content Management System). Strapi Cloud is *not* the SaaS (Software as a Service) version of Strapi CMS. Feel free to refer to the [Developer Documentation](https://docs.strapi.io/dev-docs/intro) and [User Guide](https://docs.strapi.io/user-docs/intro) to learn more about Strapi CMS.

- **Strapi Cloud Pricing Plans** <br/> As a Strapi Cloud user you have the choice between 3 tiers: Developer, Pro and Team. Depending on the tier, you have access to different functionalities, support and customization options (see [Pricing page](https://strapi.io/pricing-cloud) for more details). In this Strapi Cloud documentation, the <CloudDevBadge />, <CloudProBadge />, and <CloudTeamBadge /> badges can be displayed beside a section's title to indicate for which tier the feature is available.

- **Strapi CMS Enterprise features** <br/> Some of Strapi features, usually accessible via the Enterprise Edition of Strapi CMS, are included in some Strapi Cloud tiers (see [Pricing page](https://strapi.io/pricing-cloud) and [Information on billing & usage](/cloud/getting-started/usage-billing) for more details). These features, highlighted with an <EnterpriseBadge /> badge, are documented in the [User Guide](https://docs.strapi.io/user-docs/intro) and the [Developer Documentation](https://docs.strapi.io/dev-docs/intro).

- **Types of Strapi Cloud users** <br/> There can be 2 types of users on a Strapi Cloud project: owners and maintainers. The owner is the one who has created the project and has therefore access to all features and options for the project. Maintainers are users who have been invited to contribute to an already created project by its owner. Maintainers, as documented in the [Collaboration](/cloud/projects/collaboration) page, cannot view and access all features and options from the Strapi Cloud dashboard.

- **Support** <br/> The level of support provided by the Strapi Support team depends on the Strapi Cloud tier you subscribed for. The Developer and Pro tiers include Basic support while the Team tier includes Standard support. Please refer to the [dedicated support article](https://support.strapi.io/support/solutions/articles/67000680833-what-is-supported-by-the-strapi-team#Not-Supported) for all details regarding support levels.
Loading