You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* chore: format all files in the project
* fix: removing @types/react from dependencies
* fix: adding prettier and eslint config
* chore: format files
* fix: upgrading turbo version
* chore: ignoring warnings and adding todos
* fix: updated the type of bubble menu item in the document editor
* chore: format files
---------
Co-authored-by: Aaryan Khandelwal <[email protected]>
Access the `coolify-docker-compose` file [here](https://raw.githubusercontent.com/makeplane/plane/master/deploy/coolify/coolify-docker-compose.yml) or download using using below command
Copy file name to clipboardExpand all lines: deploy/selfhost/README.md
+43-39
Original file line number
Diff line number
Diff line change
@@ -1,49 +1,55 @@
1
-
# Self Hosting
1
+
# Self Hosting
2
2
3
-
In this guide, we will walk you through the process of setting up a self-hosted environment. Self-hosting allows you to have full control over your applications and data. It's a great way to ensure privacy, control, and customization.
3
+
In this guide, we will walk you through the process of setting up a self-hosted environment. Self-hosting allows you to have full control over your applications and data. It's a great way to ensure privacy, control, and customization.
4
4
5
-
We will cover two main options for setting up your self-hosted environment: using a cloud server or using your desktop. For the cloud server, we will use an AWS EC2 instance. For the desktop, we will use Docker to create a local environment.
5
+
We will cover two main options for setting up your self-hosted environment: using a cloud server or using your desktop. For the cloud server, we will use an AWS EC2 instance. For the desktop, we will use Docker to create a local environment.
6
6
7
7
Let's get started!
8
8
9
-
## Setting up Docker Environment
9
+
## Setting up Docker Environment
10
+
10
11
<details>
11
12
<summary>Option 1 - Using Cloud Server</summary>
12
13
<p>Best way to start is to create EC2 maching on AWS. It must of minimum t3.medium/t3a/medium</p>
13
14
<p>Run the below command to install docker engine.</p>
<li> Download Docker Desktop for Mac from the <a href="https://hub.docker.com/editions/community/docker-ce-desktop-mac/" target="_blank">Docker Hub</a>. </li>
26
29
<li> Double-click the downloaded `.dmg` file and drag the Docker app icon to the Applications folder. </li>
27
30
<li>Open Docker Desktop from the Applications folder. You might be asked to provide your system password to install additional software.</li>
28
31
</ol>
29
32
30
-
#### For Windows:
33
+
#### For Windows:
34
+
31
35
<ol>
32
36
<li>Download Docker Desktop for Windows from the <a href="https://hub.docker.com/editions/community/docker-ce-desktop-windows/" target="_blank">Docker Hub</a>.</li>
33
37
<li>Run the installer and follow the instructions. You might be asked to enable Hyper-V and "Containers" Windows features.</li>
34
38
<li>Open Docker Desktop. You might be asked to log out and log back in, or restart your machine, for changes to take effect.</li>
35
39
</ol>
36
40
37
-
After installation, you can verify the installation by opening a terminal (Command Prompt on Windows, Terminal app on Mac) and running the command `docker --version`. This should display the installed version of Docker.
41
+
After installation, you can verify the installation by opening a terminal (Command Prompt on Windows, Terminal app on Mac) and running the command `docker --version`. This should display the installed version of Docker.
42
+
38
43
</details>
39
44
40
45
---
41
46
42
47
## Installing Plane
43
48
44
-
Installing plane is a very easy and minimal step process.
49
+
Installing plane is a very easy and minimal step process.
50
+
51
+
### Prerequisite
45
52
46
-
### Prerequisite
47
53
- Docker installed and running
48
54
- OS with bash scripting enabled (Ubuntu, Linux AMI, macos). Windows systems need to have [gitbash](https://git-scm.com/download/win)
49
55
- User context used must have access to docker services. In most cases, use sudo su to switch as root user
@@ -82,11 +88,11 @@ chmod +x setup.sh
82
88
83
89
### Proceed with setup
84
90
85
-
Above steps will set you ready to install and start plane services.
91
+
Above steps will set you ready to install and start plane services.
86
92
87
-
Lets get started by running the `./setup.sh` command.
93
+
Lets get started by running the `./setup.sh` command.
88
94
89
-
This will prompt you with the below options.
95
+
This will prompt you with the below options.
90
96
91
97
```
92
98
Select a Action you want to perform:
@@ -100,26 +106,27 @@ Select a Action you want to perform:
100
106
Action [2]: 1
101
107
```
102
108
103
-
For the 1st time setup, type "1" as action input.
109
+
For the 1st time setup, type "1" as action input.
104
110
105
111
This will create a create a folder `plane-app` or `plane-app-preview` (in case of preview deployment) and will download 2 files inside that
112
+
106
113
-`docker-compose.yaml`
107
114
-`.env`
108
115
109
-
Again the `options [1-6]` will be popped up and this time hit `6` to exit.
116
+
Again the `options [1-6]` will be popped up and this time hit `6` to exit.
110
117
111
118
---
112
119
113
120
### Continue with setup - Environment Settings
114
121
115
-
Before proceeding, we suggest used to review `.env` file and set the values.
116
-
Below are the most import keys you must refer to. *<spanstyle="color: #fcba03">You can use any text editor to edit this file</span>*.
122
+
Before proceeding, we suggest used to review `.env` file and set the values.
123
+
Below are the most import keys you must refer to. _<spanstyle="color: #fcba03">You can use any text editor to edit this file</span>_.
117
124
118
125
> `NGINX_PORT` - This is default set to `80`. Make sure the port you choose to use is not preoccupied. (e.g `NGINX_PORT=8080`)
119
126
120
-
> `WEB_URL` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with NGINX_PORT (eg. `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`)
127
+
> `WEB_URL` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with NGINX_PORT (eg. `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`)
121
128
122
-
> `CORS_ALLOWED_ORIGINS` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with NGINX_PORT (eg. `https://plane.example.com:8080`or `http://[IP-ADDRESS]:8080`)
129
+
> `CORS_ALLOWED_ORIGINS` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with NGINX_PORT (eg. `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`)
123
130
124
131
There are many other settings you can play with, but we suggest you configure `EMAIL SETTINGS` as it will enable you to invite your teammates onto the platform.
125
132
@@ -148,15 +155,15 @@ Be patient as it might take sometime based on download speed and system configur
148
155
149
156

150
157
151
-
This is the confirmation that all images were downloaded and the services are up & running.
158
+
This is the confirmation that all images were downloaded and the services are up & running.
152
159
153
-
You have successfully self hosted `Plane` instance. Access the application by going to IP or domain you have configured it (e.g `https://plane.example.com:8080`or `http://[IP-ADDRESS]:8080`)
160
+
You have successfully self hosted `Plane` instance. Access the application by going to IP or domain you have configured it (e.g `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`)
154
161
155
162
---
156
163
157
164
### Stopping the Server
158
165
159
-
In case you want to make changes to `.env` variables, we suggest you to stop the services before doing that.
166
+
In case you want to make changes to `.env` variables, we suggest you to stop the services before doing that.
160
167
161
168
Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `3` to stop the sevices
162
169
@@ -180,7 +187,7 @@ If all goes well, you must see something like this
180
187
181
188
### Restarting the Server
182
189
183
-
In case you want to make changes to `.env` variables, without stopping the server or you noticed some abnormalies in services, you can restart the services with RESTART option.
190
+
In case you want to make changes to `.env` variables, without stopping the server or you noticed some abnormalies in services, you can restart the services with RESTART option.
184
191
185
192
Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `4` to restart the sevices
186
193
@@ -206,7 +213,7 @@ If all goes well, you must see something like this
206
213
207
214
It is always advised to keep Plane up to date with the latest release.
208
215
209
-
Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `5` to upgrade the release.
216
+
Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `5` to upgrade the release.
210
217
211
218
```
212
219
Select a Action you want to perform:
@@ -220,26 +227,25 @@ Select a Action you want to perform:
220
227
Action [2]: 5
221
228
```
222
229
223
-
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.
230
+
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.
224
231
225
232
You must expect the below message
226
233
227
234

228
235
229
236
Once done, choose `6` to exit from prompt.
230
237
231
-
> 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.
238
+
> 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.
232
239
233
240
Once done with making changes in `.env` file, jump on to `Start Server`
234
241
235
-
236
242
## Upgrading from v0.13.2 to v0.14.x
237
243
238
244
This is one time activity for users who are upgrading from v0.13.2 to v0.14.0
239
245
240
246
As there has been significant changes to Self Hosting process, this step mainly covers the data migration from current (v0.13.2) docker volumes from newly created volumes
241
247
242
-
> Before we begin with migration, make sure your v0.14.0 was started and then stopped. This is required to know the newly created docker volume names.
248
+
> Before we begin with migration, make sure your v0.14.0 was started and then stopped. This is required to know the newly created docker volume names.
243
249
244
250
Begin with downloading the migration script using below command
245
251
@@ -256,15 +262,15 @@ Now run the `./migrate.sh` command and expect the instructions as below
Given below list of REDIS volumes, identify the prefix of source and destination volumes leaving "_redisdata"
284
+
Given below list of REDIS volumes, identify the prefix of source and destination volumes leaving "_redisdata"
279
285
---------------------
280
286
plane-app_redisdata
281
287
v0132_redisdata
282
288
283
-
Provide the Source Volume Prefix :
289
+
Provide the Source Volume Prefix :
284
290
```
285
291
286
292
**Open another terminal window**, and run the mentioned 3 command. This may be different for users who have changed the volume names in their previous setup (v0.13.2)
@@ -289,9 +295,9 @@ For every command you must see 2 records something like shown in above example o
289
295
290
296
To move forward, you would need PREFIX of old setup and new setup. As per above example, `v0132` is the prefix of v0.13.2 and `plane-app` is the prefix of v0.14.0 setup
291
297
292
-
**Back to original terminal window**, *Provide the Source Volume Prefix* and hit ENTER.
298
+
**Back to original terminal window**, _Provide the Source Volume Prefix_ and hit ENTER.
293
299
294
-
Now you will be prompted to *Provide Destination Volume Prefix*. Provide the value and hit ENTER
300
+
Now you will be prompted to _Provide Destination Volume Prefix_. Provide the value and hit ENTER
295
301
296
302
```
297
303
Provide the Source Volume Prefix : v0132
@@ -302,8 +308,6 @@ In case the suffixes are wrong or the mentioned volumes are not found, you will
302
308
303
309

304
310
305
-
In case of successful migration, it will be a silent exit without error.
306
-
307
-
Now its time to restart v0.14.0 setup.
308
-
311
+
In case of successful migration, it will be a silent exit without error.
0 commit comments