π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
chore: 1click docs update
sriram veeraghanta552c66457a24
diff --git a/deploy/1-click/README.md b/deploy/1-click/README.mdindex fbaac930c4..783f883713 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 architectureRun β on any CLI.+```export BRANCH=previewcurl -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.---+### Manage your Plane instanceUse `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 a1. 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- <br>Default: 80- - Change your domain name- <br>Default: Deployed server's public IP address- - File upload size- <br>Default: 5MB- - Specify external database address when using an external database- <br>Default: `Empty`- <br>`Default folder: /opt/plane/data/postgres`- - Specify external Redis URL when using external Redis- <br>Default: `Empty`- <br>`Default folder: /opt/plane/data/redis`- - Configure AWS S3 bucket- <br>Use only when you or your users want to use S3- <br>`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+ <br>Default: 80+ - Change your domain name+ <br>Default: Deployed server's public IP address+ - File upload size+ <br>Default: 5MB+ - Specify external database address when using an external database+ <br>Default: `Empty`+ <br>`Default folder: /opt/plane/data/postgres`+ - Specify external Redis URL when using external Redis+ <br>Default: `Empty`+ <br>`Default folder: /opt/plane/data/redis`+ - Configure AWS S3 bucket+ <br>Use only when you or your users want to use S3+ <br>`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++ 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.+ 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.