Skip to content

Commit ff62fb7

Browse files
committed
updated readme
1 parent 88f8433 commit ff62fb7

File tree

2 files changed

+6
-23
lines changed

2 files changed

+6
-23
lines changed

deploy/selfhost/README.md

+4-21
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Let's get started!
1010

1111
<details>
1212
<summary>Option 1 - Using Cloud Server</summary>
13-
<p>Best way to start is to create EC2 maching on AWS. It must of minimum t3.medium/t3a/medium</p>
13+
<p>Best way to start is to create EC2 machine on AWS. It must have minimum of 2vCPU and 4GB RAM.</p>
1414
<p>Run the below command to install docker engine.</p>
1515

1616
`curl -fsSL https://get.docker.com | sh -`
@@ -67,23 +67,6 @@ curl -fsSL -o setup.sh https://raw.githubusercontent.com/makeplane/plane/master/
6767
chmod +x setup.sh
6868
```
6969

70-
<details>
71-
<summary>Downloading Preview Release</summary>
72-
73-
```
74-
mkdir plane-selfhost
75-
76-
cd plane-selfhost
77-
78-
export RELEASE=preview
79-
80-
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/install.sh | sed 's@BRANCH=master@BRANCH='"$RELEASE"'@' > setup.sh
81-
82-
chmod +x setup.sh
83-
```
84-
85-
</details>
86-
8770
---
8871

8972
### Proceed with setup
@@ -114,7 +97,7 @@ This will create a create a folder `plane-app` or `plane-app-preview` (in case o
11497
- `docker-compose.yaml`
11598
- `plane.env`
11699

117-
Again the `options [1-7]` will be popped up and this time hit `7` to exit.
100+
Again the `options [1-8]` will be popped up and this time hit `8` to exit.
118101

119102
---
120103

@@ -236,15 +219,15 @@ Select a Action you want to perform:
236219
Action [2]: 5
237220
```
238221

239-
By choosing this, it will stop the services and then will download the latest `docker-compose.yaml` and `variables-upgrade.env`. Here system will not replace `.env` with the new one.
222+
By choosing this, it will stop the services and then will download the latest `docker-compose.yaml` and `plane.env`.
240223

241224
You must expect the below message
242225

243226
![Alt text](images/upgrade.png)
244227

245228
Once done, choose `8` to exit from prompt.
246229

247-
> It is very important for you to compare the 2 files `variables-upgrade.env` and `.env`. Copy the newly added variable from downloaded file to `.env` and set the expected values.
230+
> It is very important for you to validate the `plane.env` for the new changes.
248231
249232
Once done with making changes in `plane.env` file, jump on to `Start Server`
250233

deploy/selfhost/install.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -262,9 +262,9 @@ function download() {
262262
fi
263263

264264
echo ""
265-
echo "Most recent Stable version is now available for you to use"
265+
echo "Most recent version of Plane is now available for you to use"
266266
echo ""
267-
echo "In case of Upgrade, your new setting file is availabe as 'variables-upgrade.env'. Please compare and set the required values in 'plane.env 'file."
267+
echo "In case of 'Upgrade', please check the 'plane.env 'file for any new variables and update them accordingly"
268268
echo ""
269269
}
270270
function startServices() {

0 commit comments

Comments
 (0)