coolLabsInstallation
This section provide details on how to install Coolify.
Before running the install script, please ensure your server has the following packages installed:
sudowgetcurl
Scripted
Prompts for answers:
bash
wget -q https://get.coollabs.io/coolify/install.sh \
-O install.sh; sudo bash ./install.sh
1
2
2
No question asked (force):
bash
wget -q https://get.coollabs.io/coolify/install.sh \
-O install.sh; sudo bash ./install.sh -f
1
2
2
Opt-out from telemetry (count installed instances on the landing page)
bash
wget -q https://get.coollabs.io/coolify/install.sh \
-O install.sh; sudo bash ./install.sh -n
1
2
2
You can review the script here.
Manually
- Need to set the required environment variables in a
.envfile (see below) - Need to have Docker Engine v20.10+ installed on your server.
Environment Variables
Coolify needs to have the following environment variables to be set in advance.
This is done automatically with the automated installation script.
text
COOLIFY_APP_ID=
COOLIFY_SECRET_KEY=
COOLIFY_DATABASE_URL=file:../db/prod.db
COOLIFY_IS_ON=docker
COOLIFY_WHITE_LABELED=false
COOLIFY_WHITE_LABELED_ICON=
COOLIFY_AUTO_UPDATE=false
1
2
3
4
5
6
7
2
3
4
5
6
7
| Variable | Explanation |
|---|---|
| COOLIFY_APP_ID | A random UUID. Used to differentiate between installed instances. Also used to enable/disable telemetry (empty = disabled). |
| COOLIFY_SECRET_KEY | Used to encrypt all kinds of private data. Must be 32 characters long. |
| COOLIFY_DATABASE_URL | SQLite database URL. Must be under ../db . |
| COOLIFY_IS_ON | Where Coolify is deployed to. Currently, only docker is supported. |
| COOLIFY_WHITE_LABELED | It removes the "branding" of your Coolify instance. Please get in touch with me before using this. |
| COOLIFY_WHITE_LABELED_ICON | A remote icon to be replaced on the login/registration page. |
| COOLIFY_AUTO_UPDATE | It updates your Coolify instance automatically behind the scenes. |
Options
sh
Usage: install.sh [options...]
-h, --help Show this help menu.
-v, --version Show script version.
-d, --debug Show debug logs during installation.
-f, --force Force installation.
-r, --restart Only restarts Coolify.
-n, --do-not-track Opt-out of telemetry.
# You can set export DO_NOT_TRACK=1 in advance.
-a, --auto-update Enable auto update feature of Coolify.
-w, --white-labeled Install white-labeled version.
# Contact me before using it: https://docs.coollabs.io/contact
-i, --white-labeled-logo Custom logo for white-labeled.
# Should be a http/https URL.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Change Configuration
You can always execute the installation script with different options to reconfigure Coolify.
For example:
- If you want to opt-out of tracking, execute the install script with
--do-not-track. - If you want to use the white-labeled version, execute the install script with
--white-labeled.
WARNING
Some configurations are not preserved if you would like to change them on an already configured instance.
These options are the following: --white-labeled, --do-no-track, --white-labeled-icon.
So if you installed Coolify with --do-no-track before, and you want to also use --white-labeled option, you need execute the install script with --do-not-track and --white-labeled!
Restart
If for some reason, your instance crashes, you can restart it with the following command:
bash
wget -q https://get.coollabs.io/coolify/install.sh \
-O install.sh; sudo bash ./install.sh -r
1
2
2
Uninstall
You can easily uninstall Coolify by stopping the following containers, coolify, coolify-proxy and coolify-fluentbit, or execute the following script:
bash
docker stop -t 0 coolify coolify-proxy coolify-fluentbit; docker rm coolify coolify-proxy coolify-fluentbit
1