From 552c66457a2408cb3295f8c92a012fb1b6a12fd3 Mon Sep 17 00:00:00 2001 From: sriram veeraghanta Date: Wed, 13 Mar 2024 17:17:40 +0530 Subject: [PATCH] chore: 1click docs update --- deploy/1-click/README.md | 62 +++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 26 deletions(-) diff --git a/deploy/1-click/README.md b/deploy/1-click/README.md index fbaac930c..783f88371 100644 --- a/deploy/1-click/README.md +++ b/deploy/1-click/README.md @@ -10,30 +10,37 @@ This short guide will guide you through the process, the background tasks that r - Supported CPU architechtures: AMD64, ARM64, x86_64, aarch64 ### Download the latest stable release + Run ↓ on any CLI. + ``` curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/1-click/install.sh | sh - ``` - ### Download the Preview release + `Preview` builds do not support ARM64/AARCH64 CPU architecture Run ↓ on any CLI. + ``` export BRANCH=preview curl -fsSL https://raw.githubusercontent.com/makeplane/plane/preview/deploy/1-click/install.sh | sh - ``` + --- + ### Successful installation + You should see ↓ if there are no hitches. That output will also list the IP address you can use to access your Plane instance. ![Install Output](images/install.png) --- + ### Manage your Plane instance Use `plane-app` [OPERATOR] to manage your Plane instance easily. Get a list of all operators with `plane-app ---help`. @@ -41,33 +48,36 @@ Use `plane-app` [OPERATOR] to manage your Plane instance easily. Get a list of a ![Plane Help](images/help.png) 1. Basic operators - 1. `plane-app start` starts the Plane server. - 2. `plane-app restart` restarts the Plane server. - 3. `plane-app stop` stops the Plane server. -2. Advanced operations - 1. `plane-app --configure` will show advanced configurators. - - Change your proxy or listening port -
Default: 80 - - Change your domain name -
Default: Deployed server's public IP address - - File upload size -
Default: 5MB - - Specify external database address when using an external database -
Default: `Empty` -
`Default folder: /opt/plane/data/postgres` - - Specify external Redis URL when using external Redis -
Default: `Empty` -
`Default folder: /opt/plane/data/redis` - - Configure AWS S3 bucket -
Use only when you or your users want to use S3 -
`Default folder: /opt/plane/data/minio` + 1. `plane-app start` starts the Plane server. + 2. `plane-app restart` restarts the Plane server. + 3. `plane-app stop` stops the Plane server. + +2. Advanced operators + `plane-app --configure` will show advanced configurators. + + - Change your proxy or listening port +
Default: 80 + - Change your domain name +
Default: Deployed server's public IP address + - File upload size +
Default: 5MB + - Specify external database address when using an external database +
Default: `Empty` +
`Default folder: /opt/plane/data/postgres` + - Specify external Redis URL when using external Redis +
Default: `Empty` +
`Default folder: /opt/plane/data/redis` + - Configure AWS S3 bucket +
Use only when you or your users want to use S3 +
`Default folder: /opt/plane/data/minio` 3. Version operators - 1. `plane-app --upgrade` gets the latest stable version of docker-compose.yaml, .env, and Docker images - 2. `plane-app --update-installer` updates the installer and the `plane-app` utility. + 1. `plane-app --upgrade` gets the latest stable version of docker-compose.yaml, .env, and Docker images - 3. `plane-app --uninstall` uninstalls the Plane application and all Docker containers from the server but leaves the data stored in - Postgres, Redis, and Minio alone. - 4. `plane-app --install` installs the Plane app again. + 2. `plane-app --update-installer` updates the installer and the `plane-app` utility. + + 3. `plane-app --uninstall` uninstalls the Plane application and all Docker containers from the server but leaves the data stored in + Postgres, Redis, and Minio alone. + 4. `plane-app --install` installs the Plane app again.