-
Couldn't load subscription status.
- Fork 1.2k
Cloud deployment #1105
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
Cloud deployment #1105
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
2cb019a
creating projects
gpene 2db6195
managing projects
gpene 6d0b20f
settings
gpene 6d25f36
sidebar
gpene e305c11
typo
gpene 016b57b
beta updates
gpene 45fd4be
list indentation
gpene 2a8e9a3
add cta callout
gpene a8dbacb
list formatting
gpene 527206f
Feedback updates
gpene 0ae4870
Update re waitlist and onboarding
gpene e9d0dce
Add min version
gpene File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+25.4 KB
...eloper-docs/latest/setup-deployment-guides/assets/deployment/cloud/advanced.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+206 KB
...veloper-docs/latest/setup-deployment-guides/assets/deployment/cloud/deploys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+28.1 KB
...eveloper-docs/latest/setup-deployment-guides/assets/deployment/cloud/import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+58.2 KB
...developer-docs/latest/setup-deployment-guides/assets/deployment/cloud/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+37.2 KB
...er-docs/latest/setup-deployment-guides/assets/deployment/cloud/project_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+24.8 KB
...-docs/latest/setup-deployment-guides/assets/deployment/cloud/projects_empty.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+160 KB
...eloper-docs/latest/setup-deployment-guides/assets/deployment/cloud/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+26.8 KB
...developer-docs/latest/setup-deployment-guides/assets/deployment/cloud/setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
131 changes: 131 additions & 0 deletions
131
docs/developer-docs/latest/setup-deployment-guides/deployment/strapi-cloud.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| --- | ||
| title: Strapi Cloud Deployment - Strapi Developer Docs | ||
| description: Learn how to deploy your Strapi application on Strapi Cloud. | ||
| canonicalUrl: https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/deployment/strapi-cloud.html | ||
| --- | ||
|
|
||
| # Strapi Cloud | ||
|
|
||
| ::: warning | ||
| Strapi Cloud is currently in Closed Beta release. Features and functionality may change prior to General Availability. | ||
| ::: | ||
|
|
||
| This is a step-by-step guide for deploying your Strapi application on Strapi Cloud. Before you are able to access Strapi Cloud, you must first [request access](#requesting-access) to the Beta release. | ||
|
|
||
| ## Requesting access | ||
|
|
||
| To request access you must sign up for the waitlist [here](https://strapi.io/cloud). Be sure to enter your correct GitHub username and Discord ID as these are used to grant access to the Strapi Cloud Beta. | ||
|
|
||
| Onboarding of users will be done in batches. You will be notified via email when you have been granted access to Strapi Cloud. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you can deploy your Strapi application on Strapi Cloud, you need to have the following prerequisites: | ||
|
|
||
| * A [GitHub](https://github.com) account | ||
| * GitHub repository for your Strapi application(s) | ||
| * Strapi version 4.1+ | ||
|
|
||
| ::: tip | ||
| The connected repository can contain multiple Strapi applications. Each Strapi app must be in a separate directory. | ||
| ::: | ||
|
|
||
| ## Getting started | ||
|
|
||
| 1. Navigate to the [Strapi Cloud](https://cloud.strapi.io) login page. | ||
|
|
||
|  | ||
|
|
||
| 2. You are prompted to **Log In with GitHub**. Your Strapi Cloud account is created during this initial login. | ||
|
|
||
| 3. Once logged in, you will be redirected to the Strapi Cloud **Projects** page. From here you can create your first Strapi Cloud project. | ||
|
|
||
|  | ||
|
|
||
| ### Create a project | ||
|
|
||
| 1. From the **Projects** page, click the **Create Project** button. You are prompted to **Connect with GitHub**. | ||
|
|
||
| ::: tip | ||
| Connect the GitHub account and/or Organizations that own the repository or repositories you want to deploy. This can be different from the account that owns the Strapi Cloud account. | ||
|
|
||
| You will be redirected to GitHub to authorize Strapi Cloud to access your repository. | ||
| ::: | ||
|
|
||
| 2. After granting the required access from GitHub, from the **Projects** page select your desired repository to install Strapi Cloud. | ||
|
|
||
|  | ||
|
|
||
| 3. Click **Next** to proceed to the Project Set up page and enter the following information: | ||
| * **Project name**: The name of your Strapi app, this is fetched from the repository name but can be edited. It is automatically converted to slug format (`my-strapi-app`). | ||
| * **GitHub branch**: The default branch to use for this deployment. This uses the [default branch](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch) of the repository but can be changed via the drop-down. | ||
| * **Deploy on push**: When enabled, this will automatically deploy the latest changes from the selected branch. When disabled, you will need to manually deploy the latest changes. | ||
|
|
||
|  | ||
|
|
||
| 4. (**Optional**) Select **Show Advanced Settings** to configure the following options: | ||
| * [**Environment variables**](../configurations/optional/environment.md): Environment variables are used to configure your Strapi app. | ||
| * **Base directory**: The directory where your Strapi app is located in the repository. This is useful if you have multiple Strapi apps in the same repository or if you have a monorepo. | ||
|
|
||
|  | ||
|
|
||
| 5. Click **Create** to finalize the project creation. An initial deployment is triggered and you are redirected to the **Projects** page. | ||
|
|
||
| ## Managing projects | ||
|
|
||
| The **Projects** page displays a list of all your Strapi Cloud projects. From here you can manage your projects and access the corresponding applications. | ||
|
|
||
|  | ||
|
|
||
| Each project card displays the following information: | ||
|
|
||
| * **Project name** | ||
| * **Status**: Displays a **Disconnected** warning if the project repository is not connected to Strapi Cloud. | ||
| * **Last deployment date**: Timestamp of the last deployment. | ||
|
|
||
| ## Project details | ||
|
|
||
| From the **Projects** page, click on any project card to access that project's details page. | ||
|
|
||
| The project details page displays the following tabs: **Deploys** and **Settings**. | ||
|
|
||
| ### Deploys | ||
|
|
||
| The **Deploys** tab displays a chronological list of cards with the details of all historical deployments for the project. | ||
|
|
||
|  | ||
|
|
||
| Each card displays the following information: | ||
|
|
||
| * **Commit SHA** | ||
| * **Commit message** | ||
| * **Deployment status**: Whether the project is | ||
| * **Deploying** | ||
| * **Done** | ||
| * **Cancelled** | ||
| * **Build failed** | ||
| * **Deploy failed** | ||
| * **Last deployment time**: When the deployment was triggered and the duration. | ||
| * **Production branch** | ||
| * **Options** menu (`...`): The available options vary depending on the deployment status. | ||
| * For **Done** status: No further options. | ||
| * For **Deploying** status, you can: | ||
| * **Cancel deploy** | ||
| * For **Build failed** status, you can: | ||
| * **Download error logs** | ||
| * For **Deploy failed** status, you can: | ||
| * **Download error logs** | ||
|
|
||
| From this page you can also trigger a new deployment and access the application using the corresponding buttons. | ||
|
|
||
| ## Settings | ||
|
|
||
| The **Settings** enables you to edit the following details for the project: | ||
|
|
||
| * **Project name**: The name of your Strapi app, used to identify the project on the Cloud Dashboard, Strapi CLI, and deployment URLs. | ||
gpene marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * **Production branch**: The branch of the linked repository to use for production deployments. | ||
| * **Environment variables**: Environment variables are used to configure the environment of your Strapi app. | ||
| * **Connected GitHub repository**: The Git repository linked to the project. | ||
| * **Delete project**: This will ***permanently and irreversibly*** delete the project and all its associated data. | ||
|
|
||
|  | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.