github/plane
0
0
Fork 1
mirror of https://github.com/makeplane/plane synced 2024-06-14 14:31:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: 1click docs update

Browse Source
This commit is contained in:
sriram veeraghanta 2024-03-13 17:17:40 +05:30
parent 1363ef0b2d
commit 552c66457a
1 changed files with 36 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
deploy/1-click/README.md
View File

@ -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 - Supported CPU architechtures: AMD64, ARM64, x86_64, aarch64
### Download the latest stable release ### Download the latest stable release
Run ↓ on any CLI. Run ↓ on any CLI.
``` ```
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/1-click/install.sh | sh - curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/1-click/install.sh | sh -
``` ```
### Download the Preview release ### Download the Preview release
`Preview` builds do not support ARM64/AARCH64 CPU architecture `Preview` builds do not support ARM64/AARCH64 CPU architecture
Run ↓ on any CLI. Run ↓ on any CLI.
``` ```
export BRANCH=preview export BRANCH=preview
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/preview/deploy/1-click/install.sh | sh - curl -fsSL https://raw.githubusercontent.com/makeplane/plane/preview/deploy/1-click/install.sh | sh -
``` ```
--- ---
### Successful installation ### 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. 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) ![Install Output](images/install.png)
--- ---
### Manage your Plane instance ### Manage your Plane instance
Use `plane-app` [OPERATOR] to manage your Plane instance easily. Get a list of all operators with `plane-app ---help`. Use `plane-app` [OPERATOR] to manage your Plane instance easily. Get a list of all operators with `plane-app ---help`.
@ -41,12 +48,14 @@ Use `plane-app` [OPERATOR] to manage your Plane instance easily. Get a list of a
![Plane Help](images/help.png) ![Plane Help](images/help.png)
1. Basic operators 1. Basic operators
1. `plane-app start` starts the Plane server. 1. `plane-app start` starts the Plane server.
2. `plane-app restart` restarts the Plane server. 2. `plane-app restart` restarts the Plane server.
3. `plane-app stop` stops the Plane server. 3. `plane-app stop` stops the Plane server.
2. Advanced operations 2. Advanced operators
1. `plane-app --configure` will show advanced configurators. `plane-app --configure` will show advanced configurators.
- Change your proxy or listening port - Change your proxy or listening port
<br>Default: 80 <br>Default: 80
- Change your domain name - Change your domain name
@ -64,6 +73,7 @@ Use `plane-app` [OPERATOR] to manage your Plane instance easily. Get a list of a
<br>`Default folder: /opt/plane/data/minio` <br>`Default folder: /opt/plane/data/minio`
3. Version operators 3. Version operators
1. `plane-app --upgrade` gets the latest stable version of docker-compose.yaml, .env, and Docker images 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. 2. `plane-app --update-installer` updates the installer and the `plane-app` utility.