-
Notifications
You must be signed in to change notification settings - Fork 8
Added pages for Prime portal #200
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a174334
Added pages for Prime portal
danciaclara b8cb99f
Merge branch 'master' of github.com:makeplane/developer-docs into pri…
danciaclara 66247a4
hide page in sidebar and search
danciaclara 6577f7a
Hide from search engines
danciaclara 417d602
Merge branch 'master' of github.com:makeplane/developer-docs into pri…
sriramveeraghanta bde8c78
fix: formatting
sriramveeraghanta 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
51 changes: 51 additions & 0 deletions
51
docs/self-hosting/methods/install-methods-commercial/docker-compose.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,51 @@ | ||
| --- | ||
| title: Docker Compose | ||
| description: Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services. | ||
| keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization | ||
| search: false | ||
| sidebar: false | ||
| head: | ||
| - - meta | ||
| - name: robots | ||
| content: noindex, nofollow | ||
| --- | ||
|
|
||
| # Docker Compose | ||
|
|
||
| This guide shows you the steps to deploy a self-hosted instance of Plane using Docker. | ||
|
|
||
| ## Install Plane | ||
|
|
||
| Plane Pro and Plane Business are enabled on this edition, so the Free plan on this edition is easier to trial our paid plans from. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - A virtual or on-prem machine with at least 2 vCPUs and 4 GB RAM (8 GB RAM recommended) | ||
| - `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs | ||
| - Supported operating systems: | ||
| - Ubuntu | ||
| - Debian | ||
| - CentOS | ||
| - Amazon Linux 2 or Linux 2023 | ||
|
|
||
| ::: info | ||
| Ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed. | ||
| ::: | ||
|
|
||
| ### Procedure | ||
|
|
||
| 1. `ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider. | ||
| 2. Run the command below: | ||
| ``` | ||
| curl -fsSL https://prime.plane.so/install/ | sh - | ||
| ``` | ||
| 3. Follow the instructions on the terminal. Hit `Enter` or `Return` to continue. | ||
| 4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`. | ||
| 5. Choose one of the options below: | ||
| - **Express**: Plane installs with the default configurations. | ||
| - **Advanced**: You can customize the database, Redis, storage and other settings. | ||
| ::: warning | ||
| When self-hosting Plane for production use, it is strongly recommended to configure [external database and storage](/self-hosting/govern/database-and-storage). This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption. | ||
| ::: | ||
| 6. The installation will take a few minutes to complete and you will see the message **Plane has successfully installed**. You can access the Plane application on the domain you provided during the installation. | ||
| 7. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarify the sentence about plan trialing.
The sentence is confusing and unclear. The phrasing "so the Free plan on this edition is easier to trial our paid plans from" is awkward and the logic is unclear.
Consider rephrasing for clarity, for example:
🤖 Prompt for AI Agents