Skip to content

Commit e77b108

Browse files
committed
2 parents 879fc7c + f45ec1f commit e77b108

File tree

9 files changed

+111
-44
lines changed

9 files changed

+111
-44
lines changed

docs/.vitepress/config.mts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,13 @@ export default defineConfig({
525525
{ text: 'Dashboard Very Slow ', link: '/troubleshoot/dashboard/dashboard-slow-performance' },
526526
]
527527
},
528+
{
529+
text: 'Server',
530+
collapsed: true,
531+
items: [
532+
{ text: 'Crash During Build ', link: '/troubleshoot/server/crash-during-build' },
533+
]
534+
},
528535
],
529536
},
530537
{

docs/get-started/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Coolify is a software that makes self-hosting simple and powerful. It lets you r
1111

1212
With Coolify, you get full control over your projects, your data, and your costs. It’s completely free to use, open-source, and has no features locked behind a paywall.
1313

14-
Think of Coolify as your personal alternative to cloud platforms like [Vercel↗](https://vercel.com), [Railway↗](https://railway.com/), or [Heroku↗](https://www.heroku.com/), but without the huge bills or privacy trade-offs.
14+
Think of Coolify as your personal alternative to cloud platforms like [Vercel↗](https://vercel.com?utm_source=coolify.io), [Railway↗](https://railway.com/?utm_source=coolify.io), or [Heroku↗](https://www.heroku.com/?utm_source=coolify.io), but without the huge bills or privacy trade-offs.
1515

1616

1717
## What Coolify Is Not
@@ -62,7 +62,7 @@ Coolify delivers unbeatable advantages for developers who want to self-host. Her
6262
## Getting Started with Coolify
6363
Before you jump into using Coolify, it’s worth understanding a few key concepts to make your journey smoother.
6464

65-
Learn about servers, SSH access, and how Coolify manages your projects by checking out our [concepts guide↗](https://coolify.io/docs/get-started/concepts).
65+
Learn about servers, SSH access, and how Coolify manages your projects by checking out our [concepts guide↗](/get-started/concepts).
6666

6767
You have two ways to use Coolify:
6868
- [Self-Host Coolify](#self-host-coolify)

docs/knowledge-base/proxy/traefik/basic-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Then you need to add the middleware to the router label, and since one or more m
7373

7474
For example you would update the current line
7575

76-
`traefik.http.routers.http-0-wc04wo4ow4scokgsw8wow4s8.middlewares=redirect-to-https`
76+
`traefik.http.routers.https-0-wc04wo4ow4scokgsw8wow4s8.middlewares=gzip`
7777

7878
to:
7979

@@ -126,4 +126,4 @@ This will generate a password hash for the user `test` with the password `test`.
126126
You can then replace `test` with the desired username and password. Then substitute the generated hash in the `basicauth.users` label above.
127127

128128
Note: the `htpasswd` command is available on most Linux distributions. It is part of the `apache2-utils` package on Debian/Ubuntu and
129-
can be found [here](https://httpd.apache.org/docs/current/programs/htpasswd.html).
129+
can be found [here](https://httpd.apache.org/docs/current/programs/htpasswd.html).

docs/knowledge-base/server/introduction.md

Lines changed: 22 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,97 +2,80 @@
22
title: "Introduction"
33
description: "A guide to help you understand what kind of servers you can connect to Coolify."
44
---
5-
65
# Introduction
7-
86
No matter what type of server you have (localhost or remote), you need the following requirements.
9-
107
- Connectivity
11-
128
- SSH connectivity between Coolify and the server with SSH key authentication.
139
::: success Tip
1410
Your public key should be added to **root** user's `~/.ssh/authorized_keys`.
15-
If you do not have an SSH Key, you can generate on through Coolify with a simple button or you can generate one manually.
11+
If you do not have an SSH Key, you can generate one through Coolify with a simple button or you can generate one manually.
1612
:::
17-
18-
1913
- Docker Engine (24+)
20-
2114
## Types
22-
2315
- **Localhost**: the server where Coolify is installed.
2416
- **Remote Server**: could be any remote linux server.
25-
2617
## Localhost
27-
2818
To be able to manage the server where Coolify is running on, the docker container of Coolify should reach the host server through SSH.
29-
3019
You can use localhost as a server where all your resources are running, but it is not recommended as high server usage could prevent to use Coolify.
31-
3220
::: success Tip
3321
You can use our [Cloud](https://app.coolify.io) version, so you only need a server for your resources.
3422

3523
You will get a few other things included with the cloud version, like free email notifications, s3 storage, etc based on your subscription plan.
3624
:::
37-
3825
## Remote Server
39-
4026
You can connect any type of servers to Coolify. It could be a VPS, a Raspberry PI or a laptop running Linux.
41-
4227
::: success Tip
4328
If you don't have a server or server provider yet, we prefer to use Hetzner.
44-
4529
You can use our [referral link](https://coolify.io/hetzner). It will help us to keep the project alive.
46-
4730
:::
48-
4931
### Cloudflare Tunnels
50-
5132
You can also set to use Cloudflare Tunnels for your servers.
52-
5333
::: success Tip
5434
Coolify does not install cloudflared on your server, it needs to be done prior.
55-
5635
All it does is to add the right ProxyCommand (`ProxyCommand <ip / hostname> access ssh --hostname %h`) to all ssh connections.
57-
5836
:::
5937

60-
## Features
38+
## Multiple Server Configuration
39+
When setting up multiple servers in Coolify, it's important to understand how traffic routing works:
6140

62-
### Disk Cleanup threshold
41+
- **Independent Proxy Handling**: Each server runs its own proxy that handles incoming requests for applications deployed on that server.
42+
- **Direct Traffic Flow**: Traffic for applications deployed on secondary servers goes directly to those servers, not through the main Coolify server.
43+
- **DNS Configuration**: You must point your domain DNS to the IP address of the server where the application is deployed, not to the main Coolify server.
6344

64-
You can read more about Automated Cleanup and the disk cleanup threshold in the [Automated Cleanup](/knowledge-base/server/automated-cleanup) section.
45+
### Role of the Main Server
46+
The main Coolify server:
47+
- Provides the management UI to control applications on all connected servers
48+
- Performs SSH connections to secondary servers for deployment and management
49+
- Conducts health checks and monitoring
50+
- Does NOT route or proxy traffic to applications on secondary servers
6551

66-
### Wildcard Domain
52+
This architecture reduces latency and improves application performance by eliminating additional network hops.
6753

54+
## Features
55+
### Disk Cleanup threshold
56+
You can read more about Automated Cleanup and the disk cleanup threshold in the [Automated Cleanup](/knowledge-base/server/automated-cleanup) section.
57+
### Wildcard Domain
6858
You can set a wildcard domain (`example: http://example.com`) to your server, so you can easily assign generated domains to all the resources connected to this server.
69-
7059
Example: Your application UUID is `vgsco4o`.
71-
7260
If you have the example set, you will get the following FQDN: `http://vgsco4o.example.com`
73-
7461
If you do not have any wildcard domain set, Coolify will generate a [sslip.io](https://sslip.io) domain, which is free & magical domain that you can use anywhere.
75-
7662
In this case, it will be: `http://vgsco4o.127.0.0.1.sslip.io`, where `127.0.0.1` is your server's IP.
7763

78-
## Proxy
64+
::: success Tip
65+
When using multiple servers, remember that each application's domain must point to the specific server where that application is deployed.
66+
:::
7967

68+
## Proxy
8069
- **Traefik**: Automatically configure Traefik(v2) based on your deployed resources.
8170
- **Custom/None**: You will configure a proxy manually (only for advanced users).
82-
8371
::: success Tip
8472
Soon we will support Nginx & Caddy with fully automated configuration.
8573
:::
86-
8774
### Traefik
88-
8975
Coolify uses Traefik proxy by default to create a reverse proxy for your resources.
90-
9176
::: success Tip
9277
Traefik only starts when you did not select any proxy for your server and you
9378
have a domain configured for a resource or your Coolify instance itself.
9479
:::
95-
9680
#### Dynamic Configuration
97-
98-
You can always add your own configuration to the proxy settings from Coolify's UI (`/server/<server_uuid>/proxy`).
81+
You can always add your own configuration to the proxy settings from Coolify's UI (`/server/<server_uuid>/proxy`).

docs/public/images/sponsors/comp.webp

6.84 KB
Binary file not shown.

docs/public/images/sponsors/yaak.webp

11.6 KB
Binary file not shown.

docs/resource/sponsors.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const sponsors = [
7373
name: 'CodeRabbit',
7474
title: 'Cut Code Review Time & Bugs in Half',
7575
links: [
76-
{ icon: 'expedia', link: 'https://www.coderabbit.io/?ref=coolify.io&utm_source=coolify.io' }
76+
{ icon: 'expedia', link: 'https://coderabbit.ai/?ref=coolify.io' }
7777
]
7878
},
7979
{
@@ -244,6 +244,22 @@ const sponsors = [
244244
{ icon: 'expedia', link: 'https://liquidweb.com/?utm_source=coolify.io' }
245245
]
246246
},
247+
{
248+
avatar: '../images/sponsors/yaak.webp',
249+
name: 'Yaak',
250+
title: 'The API client for modern developers',
251+
links: [
252+
{ icon: 'expedia', link: 'https://yaak.app/?ref=coolify.io' }
253+
]
254+
},
255+
{
256+
avatar: '../images/sponsors/comp.webp',
257+
name: 'Comp AI',
258+
title: 'The open-source platform that automates compliance.',
259+
links: [
260+
{ icon: 'expedia', link: 'https://www.trycomp.ai/?ref=coolify.io' }
261+
]
262+
},
247263
{
248264
avatar: '../images/team/coollabs.webp',
249265
name: 'You Company?',

docs/services/supabase.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ The open source Firebase alternative.
1313

1414
<ZoomableImage src="/docs/images/services/supabase-selfhost.webp" />
1515

16+
## Notes
17+
18+
You can find your anonymous key in the **Environment Variables** area under **SERVICE_SUPABASEANON_KEY**.
19+
1620
## Links
1721

1822
- [Official Website ›](https://supabase.io)
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Server Crash During Build
3+
---
4+
5+
6+
# Server Unresponsive or crashes during Build
7+
Coolify supports two deployment methods: deploying with a **pre-built** Docker image and building from **source**. Knowing which method you're using can help you fix performance problems better.
8+
9+
## 1. Understanding Your Deployment Method
10+
### A. Pre-built Docker Image Deployment
11+
- Coolify starts a new container from an existing Docker image that you or someone else have already built.
12+
13+
### B. Building from Source Deployment
14+
- Coolify builds a Docker image on your server using your application’s source code, and then starts a container from this newly created docker image.
15+
16+
17+
## 2. Troubleshooting Performance Issues
18+
If your server becomes very slow or crashes during deployment, consider the following steps based on your deployment method:
19+
20+
- **For Pre-built Image Deployments:**
21+
- Since the container is started directly from the docker image, high resource usage is most likely due to the running application.
22+
- **Solution:** Consider upgrading your server to better accommodate the application’s resource needs.
23+
24+
- **For Building from Source Deployments:**
25+
- The docker image build process can overload your server.
26+
- **Solution:** Offload the build process to an external [Build Server](/knowledge-base/server/build-server), or use an alternative method such as [GitHub Actions](https://docs.github.com/en/actions) to handle the build externally. Alternatively, consider upgrading your server’s capacity.
27+
28+
- **General Tip:**
29+
SSH into your server and run `htop` to monitor processes. Identify any process consuming excessive resources, and kill it if necessary.
30+
31+
32+
## 3. Offloading Builds with GitHub Actions
33+
To reduce the load on your server during deployments, follow this process:
34+
- **Process:**
35+
- Use [GitHub Actions](https://docs.github.com/en/actions) to build your Docker image externally.
36+
- Push the built image to a container registry (e.g., [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry)).
37+
- Once the build is complete, configure coolify to deploy the new version automatically.
38+
39+
- **Benefit:** This method minimizes the workload on your server, resulting in smoother deployments.
40+
41+
- **Learn More:** [View our GitHub Actions workflow file](https://github.com/coollabsio/documentation-coolify/blob/main/.github/workflows/production-build.yml).
42+
43+
44+
## Summary
45+
- **Deployment Methods:**
46+
- **Pre-built Image:** Directly starts a container from an existing image.
47+
- **Building from Source:** Builds an image on your server before starting a container.
48+
- **Troubleshooting:**
49+
- Identify if the issue is due to the application’s resource needs or the image build process.
50+
- Upgrade your server or offload builds as needed.
51+
- **Optimization:**
52+
- Using GitHub Actions to build Docker images externally can significantly reduce local resource usage.
53+
54+
## Support
55+
If none of the above steps work, then follow this:
56+
- **Community Help:** Join our [Discord community ↗](https://coolify.io/discord) and create a post in the support forum channel.
57+
- **What to Share:** The issue you are facing, your server specifications (e.g., operating system, CPU, RAM), and a description of the steps you’ve already tried.

0 commit comments

Comments
 (0)