Skip to content

Commit

Permalink
final fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Dancia Clara authored and Dancia Clara committed Sep 17, 2024
1 parent d674eca commit ec973b6
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 24 deletions.
4 changes: 2 additions & 2 deletions self-hosting/manage/prime-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ sidebarTitle: Prime CLI
<Warning>Update your CLI with the command `sudo prime-cli update-cli` before you download any Plane updates. The latest version of the CLI ensures your Plane upgrades happen smoothly.</Warning>

The Prime CLI is our own command-line interface to help you install, upgrade, and manage your Enterprise edition instance without being a pro at Docker.
The Prime CLI is our own command-line interface to help you install, upgrade, and manage your Commercial edition instance without being a pro at Docker.

<Note>
If you are on the Community edition and want to upgrade to the Enterprise edition, see [Upgrade from Community](/self-hosting/manage-plans/upgrade-from-community).
If you are on the Community edition and want to upgrade to the Commercial edition, see [Upgrade from Community](/self-hosting/manage-plans/upgrade-from-community).
</Note>

Bring up the Prime CLI with ```sudo prime-cli``` from any directory on your machine.
Expand Down
2 changes: 1 addition & 1 deletion self-hosting/methods/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Docker
This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.

## Recommended edition
Plane One and Plane Pro are enabled on this edition. If you would like to try the Community Edition first, [click here](#community-edition).
Plane One and Plane Pro are enabled on this edition, so the Free plan on this edition is easier to trial our paid plans from.

### Prerequisites

Expand Down
6 changes: 3 additions & 3 deletions self-hosting/methods/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Kubernetes
This guide shows you the steps to deploy a self-hosted instance of Plane using Kubernetes.

## Recommended edition
Plane One and Plane Pro are enabled on this edition. If you would like to try the Community Edition first, [click here](#community-edition).
Plane One and Plane Pro are enabled on this edition, so the Free plan on this edition is easier to trial our paid plans from.

### Prerequisites

Expand Down Expand Up @@ -51,7 +51,7 @@ Plane One and Plane Pro are enabled on this edition. If you would like to try th
```

<Note>
This is the minimum required to set up Plane Enterprise. You can change the default namespace from `plane`, the default app name from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to
This is the minimum required to set up Plane Commercial edition. You can change the default namespace from `plane`, the default app name from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to
whatever you would like to.<br/> <br/>
You can also pass other settings referring to `Configuration Settings` section.
</Note>
Expand Down Expand Up @@ -97,7 +97,7 @@ Plane One and Plane Pro are enabled on this edition. If you would like to try th

| Setting | Default | Required | Description |
|---|:---:|:---:|---|
| dockerRegistry.enabled | false | | Plane uses a private Docker registry which needs authenticated login. This must be set to `true` to install Plane Enterprise. |
| dockerRegistry.enabled | false | | Plane uses a private Docker registry which needs authenticated login. This must be set to `true` to install Plane Commerical edition. |
| dockerRegistry.registry | registry.plane.tools| Yes | The host that will serve the required Docker images; Don't change this. |
| dockerRegistry.loginid | | Yes | Sets the `loginid` for the Docker registry. This is the same as the REG_USER_ID value on prime. plane.so |
| dockerRegistry.password | | Yes | Sets the `password` for the Docker registry. This is the same as the REG_PASSWORD value on prime.plane.so|
Expand Down
8 changes: 4 additions & 4 deletions self-hosting/upgrade-from-community.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Upgrade from Community to Enterprise
title: Upgrade from Community to Commercial Edition
sidebarTitle: Upgrade from Community
---

Expand Down Expand Up @@ -47,6 +47,6 @@ e.g., `~/ce-backup`
mv $TARGET_DIR/uploads/ $TARGET_DIR/minio/uploads/
```
3. This script will extract your Community Edition data and restore it to /opt/plane/data.
4. Install **Enterprise** edition.
- Using [Docker](http://localhost:3000/self-hosting/methods/docker-compose#enterprise-edition)
- Using [Kubernetes](http://localhost:3000/self-hosting/methods/kubernetes#enterprise-edition)
4. Install **Commercial** edition.
- Using [Docker](/self-hosting/methods/docker-compose#recommended-edition)
- Using [Kubernetes](/self-hosting/methods/kubernetes#recommended-edition)
32 changes: 18 additions & 14 deletions workspaces-and-users/upgrade-plan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,49 @@ title: Plan upgrades
sidebarTitle: Plan upgrades
---

<Note>
If you are on the Community edition and want to upgrade to the Enterprise edition, see [Upgrade from Community](/self-hosting/manage-plans/upgrade-from-community).
</Note>
<Tip>
If you are on the Community edition and want to upgrade to the Enterprise edition, see [Upgrade from Community](/self-hosting/upgrade-from-community).
</Tip>

## Cloud and self-hosted

To upgrade to a paid plan, follow the steps below:
<Warning>
Self-hosted editions will need one more step. [See here](#self-hosted-only).
</Warning>

1. On the Plane app, click the **** icon next to your workspace name on the sidebar and select **Workspace Settings**.
<Frame>![Workspace settings](/images/activate-license/workspace-settings.webp)</Frame>
2. Select **Billing and plans** under **Settings**.
<Frame>![Billings and plans](/images/activate-license/billing-and-plans-cloud.webp)</Frame>
3. Select the **Monthly** or **Yearly** tab to choose the billing cycle.
3. Select the **Monthly** or **Yearly** tab to choose the billing cycle for Pro.
4. Click the **Upgrade** button.
<Note>
If you are on Cloud, you can click the **Start free trial** button under the Pro plan to opt for a 14-day free trial.
If you are on Cloud, you can click the **Start free trial** button under the Pro plan to opt for a 14-day free trial. Trials aren't available for self-hosted paid plans.
</Note>
5. Clicking the **Upgrade** button will redirect you to a Stripe payment page. Enter the card information and click **Subscribe**.
6. After processing the payment, you will see a confirmation as shown below.
5. Clicking the **Upgrade** button will redirect you to a Stripe page. Enter your payment info and click **Subscribe**.
6. If your transaction goes through, you will see a confirmation as shown below.
<Frame>![Plan activated confirmation](/images/activate-license/activate-pro-license.webp)</Frame>
7. That's it. To check your plan at any time and find additional details, just go to the **Billing and plans** tab in **Workspace Settings**.
<Frame>![Manage subscription](/images/activate-license/pro-activated-cloud.webp)</Frame>

## Self-hosted only
<Note>
<Warning>
Starting v1.3.0, your license will need to be activated on a self-hosted instance of our Enterprise Edition. Each license can be used to activate only one workspace.
</Note>
</Warning>

Steps 1 to 5 above are exactly the same when upgrading to a paid plan on your self-hosted instance. To activate the license on your workspace, follow the steps below:
Steps #1 through #5 from above work the exact same way on self-hosted, too. To activate the license on your workspace, follow the steps below:

1. After processing the payment, you will be redirected to the [Prime portal](https://prime.plane.so/licenses), where you can access all the licenses you have purchased.
1. If your payment goes through, you will be redirected to the [Prime portal](https://prime.plane.so/licenses), your one-stop interface to manage your licenses and buy new ones. Find the license by the plan you just subscribed to.
<Frame>![Manage licenses](/images/activate-license/copy-license-key.webp)</Frame>
<Note>
If you want to purchase more licenses for your other workspaces, you can directly do that in the [Prime portal](https://prime.plane.so/licenses/plans) instead of the **Billing and plans** screen. Click the **Get more licenses** button as shown in the image above to buy more licenses.
Click the Get more licenses button as in the image above on the [Prime portal](https://prime.plane.so/licenses/plans) to buy more licenses.
</Note>
2. Copy the **License key** for the license you want to activate.
3. Go back to the **Billing and plans** screen. Click the **Activate this Workspace** button.
3. Go back to the **Billing and plans** screen, usually already open in your browser.
4. Click the **Activate this Workspace** button.
<Frame>![Activate workspace](/images/activate-license/enter-license-key-selfhosted.webp)</Frame>
4. Paste the license key in the **Enter license key** box in the **Activate workspace** modal.
5. Paste the license key in the **Enter license key** box.
5. Click **Activate**. You will see a confirmation.
6. That's it. To check your plan at any time and find additional details, just go to the **Billing and plans** tab in **Workspace Settings**.
<Frame>![Manage subscription](/images/activate-license/pro-activated-cloud.webp)</Frame>

0 comments on commit ec973b6

Please sign in to comment.