Skip to content

Commit f3d6c97

Browse files
committed
2 parents f3966a8 + 521cbe3 commit f3d6c97

28 files changed

+618
-498
lines changed

docs/.vitepress/config.mts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,14 @@ export default defineConfig({
8383
text: 'Get Started',
8484
collapsed: false,
8585
items: [
86-
{ text: 'What is Coolify?', link: '/what-is-coolify' },
87-
{ text: 'Cloud vs Self-Hosted', link: '/cloud-vs-selfhost' },
88-
{ text: 'Installation', link: '/installation' },
89-
{ text: 'Upgrade', link: '/upgrade' },
90-
{ text: 'Downgrade', link: '/downgrade' },
91-
{ text: 'Uninstallation', link: '/uninstallation' },
86+
{ text: 'Introduction', link: '/get-started/introduction' },
87+
{ text: 'Concepts', link: '/get-started/concepts' },
88+
{ text: 'Usage', link: '/get-started/usage' },
89+
{ text: 'Installation', link: '/get-started/installation' },
90+
{ text: 'Upgrade', link: '/get-started/upgrade' },
91+
{ text: 'Downgrade', link: '/get-started/downgrade' },
92+
{ text: 'Uninstallation', link: '/get-started/uninstallation' },
93+
{ text: 'Support', link: '/get-started/support' },
9294
],
9395
},
9496
{

docs/cloud-vs-selfhost.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/dev.md

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,6 @@
11

22
This is a temporary page to test or paste useful stuffs during the developement.
3-
Remove this page once the doc goes live to public.
43

54

6-
7-
# Dev
8-
::: tip ⚡️ Quick Installation (recommended):
9-
``` sh
10-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
11-
```
12-
For detailed setup instructions, including firewall configuration and prerequisites, see the Quick Installation Guide below.
13-
:::
14-
15-
## Custom Callouts v0.1
16-
::: info ⚡️ Quick Installation (recommended):
17-
That was EZ
18-
```sh
19-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
20-
```
21-
:::
22-
23-
::: details ⚡️ Quick Installation (recommended):
24-
That was EZ
25-
```sh
26-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
27-
```
28-
:::
29-
30-
::: tip ⚡️ Quick Installation (recommended):
31-
That was EZ
32-
```sh
33-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
34-
```
35-
:::
36-
37-
::: warning ⚡️ Quick Installation (recommended):
38-
That was EZ
39-
```sh
40-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
41-
```
42-
:::
43-
44-
::: danger ⚡️ Quick Installation (recommended):
45-
That was EZ
46-
```sh
47-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
48-
```
49-
:::
5+
New tagline on docs landing:
6+
tagline: A software that makes self-hosting simple and powerful. Coolify lets you run your applications, databases, and services on your own server easily.

docs/get-started/concepts.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Coolify Concepts
3+
---
4+
5+
<ZoomableImage src="/docs/images/get-started/concepts-banner.webp" />
6+
7+
<br />
8+
9+
Many people start their self-hosting journey after discovering Coolify. If you’re one of them, here’s a list of a few concepts that could make your experience smoother.
10+
11+
12+
## Servers
13+
A server is a computer designed to run applications or services, providing the necessary computing power for your projects.
14+
15+
It can be either physical such as a machine you have at home, like a Raspberry Pi, or one rented from a hosting provider like Hetzner.
16+
17+
18+
## Resources
19+
In Coolify, a resource refers to an application or service you set up on your server—like a website, database, or API.
20+
21+
Each resource comes with its own configuration, like domains, backups, health checks, and so on.
22+
23+
Coolify offers a handy list of pre-set resources, called one-click services, that you can deploy instantly. But if you prefer, you can also deploy your own application easily.
24+
25+
26+
## Environments
27+
In Coolify, a environment is a tailored setup on your server that determines how your resources operate.
28+
29+
For instance, you could have a development environment for testing and debugging your code, alongside a production environment where your finished application goes live.
30+
31+
With Coolify, you can set up multiple environments on a single server, letting you switch between them effortlessly.
32+
33+
34+
## Projects
35+
A project in Coolify is a group of environments and resources you’ve deployed on your server.
36+
37+
It serves as the highest-level structure in Coolify, organizing your deployment setup.
38+
39+
You can manage multiple projects on the same server, each with its own unique set of environments and resources.
40+
41+
For example, you might create one project for all your hobby-related resources and another for work-related ones.
42+
43+
44+
## Containers
45+
In Coolify, everything you deploy runs as a Docker container, making it easy to manage and isolate your application.
46+
47+
You can use pre-built Docker images from public registries like Docker Hub or GitHub Container Registry to deploy without building them yourself.
48+
49+
To deploy, you need a Docker image, either one you’ve built or one from someone else.
50+
51+
If you’re coding your own app, Coolify can auto-build the image from a Dockerfile or Docker Compose file, though this resource-heavy process requires a capable server.
52+
53+
Alternatively, you can build the image elsewhere, push it to a registry, and let Coolify deploy it as a container.
54+
55+
56+
## Reverse Proxy
57+
A reverse proxy is a server or app that sits between your application and users, forwarding requests to the right place.
58+
59+
Coolify includes two proxy options, Caddy and Traefik, which handle requests to your website by directing them to the container running your app.
60+
61+
This setup lets you run multiple applications on one server without tweaking configs or ports.
62+
63+
Plus, Coolify supports unlimited domains, so you could deploy 20 different apps, each with its own unique domain.
64+
65+
66+
## Security
67+
Coolify doesn’t manage your server’s security or updates, that’s your responsibility to keep everything secure and up to date.
68+
69+
It’s built to simplify deployment management for you. While the Coolify core team plans to introduce more security features eventually, for now, securing your server is entirely up to you.
70+
71+
## Teams
72+
Coolify supports multiple users and teams, allowing each team to have its own projects and environments.
73+
74+
You can assign roles like admin to users, simplifying project management and collaboration on a single server.
75+
76+
Currently, the teams feature isn’t fully polished for production use, but the Coolify core team plans to enhance it down the line.
Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,25 @@
22
title: Downgrading Coolify
33
---
44

5-
# Downgrading Coolify
6-
If you're using [Coolify Cloud ↗](https://coolify.io/pricing/), please note that you **cannot** downgrade the version of Coolify, as the cloud instances are managed by the [Core Team ↗](/resource/team). If you are facing any issues, please contact [support ↗](/support).
5+
<ZoomableImage src="/docs/images/get-started/downgrade-banner.webp" />
76

8-
The following instructions are for those who are self-hosting Coolify and wish to downgrade their instance.
7+
<br />
98

10-
If you're experiencing issues with the latest version of Coolify, you can easily downgrade to the previous version. Follow the steps below to perform a downgrade on your self-hosted instance.
9+
If you're using [Coolify Cloud ↗](https://coolify.io/pricing/), the Coolify team handles all updates so you **cannot** downgrade the version of Coolify. If you are facing any issues, please contact [support ↗](/get-started/support).
1110

12-
::: danger CAUTION!!
13-
**Downgrading can introduce issues, so it is recommended to test the downgrade process in a staging environment before applying it to your production server.**
11+
12+
For those who **self-host** Coolify, you can easily downgrade to the previous version. Follow the steps below to perform a downgrade on to a previous version.
13+
14+
:::danger **Backup First!**
15+
> **Always back up your Coolify data before performing an downgrade.**
16+
> **Downgrading can introduce issues that can be difficult to fix.**
1417
:::
1518

1619

20+
1721
The Downgrade process involves the following three steps:
1822
- [Disable Auto Update](#_1-disable-auto-update)
19-
- [Login to the Server via SSH](#_2-login-to-your-server-via-ssh)
23+
- [Login to Your Server via SSH](#_2-login-to-your-server-via-ssh)
2024
- [Execute the Downgrade Command](#_3-execute-the-downgrade-command)
2125

2226

@@ -29,7 +33,7 @@ Before downgrading, it's important to disable the Auto Update feature to prevent
2933

3034
3. In the Settings menu, disable the **Auto Update** feature.
3135

32-
<ZoomableImage src="/docs/images/get-started/upgrade-disable-auto-update.webp" />
36+
<ZoomableImage src="/docs/images/get-started/upgrade/disable-auto-update.webp" />
3337

3438
::: warning Important!
3539
Disabling auto-update is essential, as it ensures that Coolify doesn’t override your downgrade with a newer version.
@@ -43,13 +47,13 @@ Next, you need to SSH into your server to execute the downgrade command.
4347
## 3. Execute the Downgrade Command
4448
To downgrade Coolify to the desired version, run the following command in your terminal:
4549
```sh
46-
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | sudo bash -s 4.0.0-beta.369
50+
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash -s 4.0.0-beta.369
4751
```
4852
Replace `4.0.0-beta.369` with the version number you want to downgrade to.
4953

5054
For example, you can downgrade to `4.0.0-beta.333` or any previous version.
5155

52-
::: info 📌 Info
56+
::: warning Note
5357
Double-check the version number you are specifying to ensure you are downgrading to the correct version. You can check the Coolify [release notes ↗](https://github.com/coollabsio/coolify/releases) for version details.
5458
:::
5559

0 commit comments

Comments
 (0)