Merge pull request #332 from Cinzya/feature/healthcheck

Author: Cinzya

docs/.vitepress/config.mts

@@ -370,7 +370,6 @@ export default defineConfig({
                       { text: 'Custom SSL Certificates', link: '/knowledge-base/proxy/traefik/custom-ssl-certs' },
                       { text: 'Dashboard', link: '/knowledge-base/proxy/traefik/dashboard' },
                       { text: 'Dynamic Configurations', link: '/knowledge-base/proxy/traefik/dynamic-config' },
-                      { text: 'Healthcheck', link: '/knowledge-base/proxy/traefik/healthchecks' },
                       { text: 'Load Balancing', link: '/knowledge-base/proxy/traefik/load-balancing' },
                       { text: 'Redirects', link: '/knowledge-base/proxy/traefik/redirects' },
                       { text: 'Wildcard SSL Certificates', link: '/knowledge-base/proxy/traefik/wildcard-certs' },

docs/knowledge-base/environment-variables.md

@@ -4,6 +4,7 @@ description: "A guide how to use environment variables in Coolify."
 ---
 
 # Environment Variables
+
 You can define environment variables for your resources, and they will be available in your application.
 
 > Preview Deployments could have different environment variables, so you can test your application as a staging environment for example.
@@ -25,15 +26,19 @@ You can set shared variables on their respective pages.
 Then you can use these variables anywhere. For example: You defined `NODE_ENV` to `production`.
 
 ### Team Based
+
 You can set them on the `Team` page and use it with <code v-pre>{{team.NODE_ENV}}</code>. Do not replace "team" with your actual team name.
 
 ### Project Based
+
 You can set them on the `Projects` page, under the gear icon and use it with <code v-pre>{{project.NODE_ENV}}</code>. Do not replace "project" with your actual project name.
 
 ### Environment Based
+
 You can set them on the `Environments` page (select a `Project`), under the gear icon and use it with <code v-pre>{{environment.NODE_ENV}}</code> Do not replace "environment" with your actual environment name.
 
 #### Using Shared Variables in Compose File
+
 If you want to use the environment variables in your compose file, you can do so by using the following syntax:
 
 ```bash
@@ -49,41 +54,50 @@ NODE_ENV={{team.NODE_ENV}}
 
 ## Predefined Variables
 
-Coolify predefines some variables for you, so you can use them in your application. All you need to do is to add an environment variable like this to your application.
+Coolify predefines some variables for you, so you can use them in your application or service. All you need to do is to add an environment variable like this to your application or service.
 
 ```bash
 # For example, you can use this variable in your application
 MY_VARIABLE=$SOURCE_COMMIT
 # You will have the commit hash of the source code in your application as an environment variable in MY_VARIABLE
 ```
 
-### `COOLIFY_FQDN`
+### Application Variables
+
+#### `COOLIFY_FQDN`
 
 Fully qualified domain name(s) of the application.
 
-### `COOLIFY_URL`
+#### `COOLIFY_URL`
 
 URL(s) of the application.
 
-### `COOLIFY_BRANCH`
+#### `COOLIFY_BRANCH`
 
 Branch name of the source code.
 
-### `COOLIFY_RESOURCE_UUID`
+#### `COOLIFY_RESOURCE_UUID`
 
 Unique resource identifier generated by Coolify.
 
-### `COOLIFY_CONTAINER_NAME`
+#### `COOLIFY_CONTAINER_NAME`
 
 Name of the container generated by Coolify.
 
-### `SOURCE_COMMIT`
+#### `SOURCE_COMMIT`
 
 Commit hash of the source code.
 
-### `PORT`
+#### `PORT`
 
 If not set: it is set to the `Port Exposes`'s first port.
 
-### `HOST`
+#### `HOST`
+
 If not set: it is set to `0.0.0.0`
+
+### Service Stack Variables
+
+#### `SERVICE_NAME_<SERVICE>`
+
+The service name of a given service in the stack. For example, if you have a service named `web`, you can access it with `SERVICE_NAME_WEB`. Useful for preview deployments where service names will vary.

docs/knowledge-base/health-checks.md

@@ -1,24 +1,49 @@
 ---
 title: Health checks
+description: Learn how to manage health checks in Coolify for your applications and services.
+keywords: ["Healthchecks", "Not Found", "No available server", "404", "503"]
 ---
 
 # Health checks
-Health checks are important, but not mandatory for your application. It is a way to check if your application is started properly. Coolify provides a way to configure health checks for your application.
 
-## How it works
+Health checks are a way to ensure that your applications and services are running correctly. They allow Coolify to monitor the health of your resources and ensure that traffic is only routed to healthy instances. This for example important for [Rolling Updates](/knowledge-base/rolling-updates) to work correctly.
 
-If you set a health check, Coolify (and integrated proxy) will check the health of your application by sending a request to the health check endpoint.
+## Traefik
 
-The integrated proxy only forwards the request to your application if the health check is successful. If the health check fails, the proxy will return a 502 Bad Gateway error.
+When using Traefik as the reverse proxy, health checks are an integral part of how it routes traffic to your resources.
 
-## What if I do not set a health check?
+### Enabled
 
-You get a warning next to your application's status. It is not mandatory, but it is recommended to set a health check.
-The integrated proxy will forward the request to your application without checking the health.
+If your resource has health checks _enabled_, Traefik will only route traffic to it if the health check passes. If the health check fails, Traefik will not route traffic to the resource.
 
-::: warning  Caution!
-Health checks run inside your container, so you need to have either `curl` or `wget` installed on your container. You can use an docker image that already includes `curl/wget` or add it to your Dockerfile yourself.
+**It will cause the resource to return a `404 Not Found` or `No available server` error.**
 
-Without one of these packages, health checks will always fail and mark your container as unhealthy, which will cause the deployment to fail due to the failing health check.
-:::
+### Disabled
+
+If your resource has health checks _disabled_, Traefik will route traffic to it regardless of the health check status.
+
+## Configure Health checks
+
+### Applications
+
+There are two ways to configure health checks for your applications:
+
+<ZoomableImage src="/docs/images/knowledge-base/resources/healthcheck.webp" />
+
+1. **Using the UI**: You can set up health checks directly in the Coolify UI when creating or editing an application. You can specify the path to check, the expected response code, and the interval for checking. It will be required that the container has either `curl` or `wget` installed to perform the health checks.
 
+2. **Using the Dockerfile**: You can also define health checks in your Dockerfile using the [HEALTHCHECK](https://docs.docker.com/reference/dockerfile/#healthcheck) instruction. This allows you to specify how the health check should be performed, including the command to run and the expected response.
+
+If there are healthchecks both in the UI and in the Dockerfile defined and enabled, the Dockerfile will take precedence.
+
+### Service Stacks
+
+Services or Applications that use the [Docker Compose Build Pack](/builds/packs/docker-compose) require their health checks to be defined in the `Dockerfile` of each service, or in their `docker-compose.y[a]ml` file using the [healthcheck](https://docs.docker.com/reference/compose-file/services/#healthcheck) attribute.
+
+::: tip When to use health checks?
+It is recommended to enable health checks for all your resources. This way, you can ensure that only healthy resources are receiving traffic.
+
+But if you cannot set up health checks for some reason, you can disable them.
+
+Just be aware that if the resource is unhealthy, it will still receive traffic.
+:::

docs/knowledge-base/proxy/traefik/healthchecks.md

@@ -3,50 +3,51 @@ title: "Traefik Overview"
 ---
 
 # Traefik Proxy
-[Traefik ↗](https://traefik.io/) is a modern, open-source reverse proxy and load balancer designed to handle incoming requests and route them to the appropriate services. It’s widely used in the container ecosystem, making it a perfect fit for projects running on Coolify.  
 
-By default, Coolify uses Traefik as its proxy, enabling easy management of routing, SSL certificates, and more, without requiring deep technical expertise.  
+[Traefik ↗](https://traefik.io/) is a modern, open-source reverse proxy and load balancer designed to handle incoming requests and route them to the appropriate services. It’s widely used in the container ecosystem, making it a perfect fit for projects running on Coolify.
 
+By default, Coolify uses Traefik as its proxy, enabling easy management of routing, SSL certificates, and more, without requiring deep technical expertise.
 
-## Why Use Traefik?  
-- Dynamically manages routing between your apps and the internet.  
-- Integrates seamlessly with container orchestrators like Docker or Kubernetes.  
-- Simplifies SSL/TLS certificate management, including support for [Let's Encrypt ↗](https://letsencrypt.org/).  
-- Offers advanced features like load balancing and middleware for fine-grained control.  
-- Comes with a built-in dashboard for monitoring routes and configurations.  
+## Why Use Traefik?
 
+- Dynamically manages routing between your apps and the internet.
+- Integrates seamlessly with container orchestrators like Docker or Kubernetes.
+- Simplifies SSL/TLS certificate management, including support for [Let's Encrypt ↗](https://letsencrypt.org/).
+- Offers advanced features like load balancing and middleware for fine-grained control.
+- Comes with a built-in dashboard for monitoring routes and configurations.
 
-## When Not to Use Traefik?  
-- If you need complete control over every aspect of your reverse proxy.  
-- If you prefer using another reverse proxy solution like [NGINX ↗](https://nginx.org/en/).  
-- If you have highly customized or complex routing rules that Traefik might not fully support.  
+## When Not to Use Traefik?
 
+- If you need complete control over every aspect of your reverse proxy.
+- If you prefer using another reverse proxy solution like [NGINX ↗](https://nginx.org/en/).
+- If you have highly customized or complex routing rules that Traefik might not fully support.
 
-## Ways to Use Traefik with Coolify  
-Coolify automatically configures Traefik as your proxy. However, you can customize and extend Traefik's functionality based on your needs. 
+## Ways to Use Traefik with Coolify
 
-Below are some of the key features and ways you can use Traefik with Coolify:  
+Coolify automatically configures Traefik as your proxy. However, you can customize and extend Traefik's functionality based on your needs.
 
-1. [Basic Authentication](/knowledge-base/proxy/traefik/basic-auth) -> Add username and password protection to your applications.  
+Below are some of the key features and ways you can use Traefik with Coolify:
 
-2. [Custom SSL Certificates](/knowledge-base/proxy/traefik/custom-ssl-certs) -> Use your own SSL certificates instead of automatically generated ones.  
+1. [Basic Authentication](/knowledge-base/proxy/traefik/basic-auth) -> Add username and password protection to your applications.
 
-3. [Dashboard](/knowledge-base/proxy/traefik/dashboard) -> Enable Traefik’s built-in dashboard for real-time monitoring and insights.  
+2. [Custom SSL Certificates](/knowledge-base/proxy/traefik/custom-ssl-certs) -> Use your own SSL certificates instead of automatically generated ones.
 
-4. [Dynamic Configuration](/knowledge-base/proxy/traefik/dynamic-config) -> Manage dynamic configuration changes like routing rules or middlewares.  
+3. [Dashboard](/knowledge-base/proxy/traefik/dashboard) -> Enable Traefik’s built-in dashboard for real-time monitoring and insights.
 
-5. [Health Checks](/knowledge-base/proxy/traefik/healthchecks) -> Configure health checks to ensure your applications are running smoothly.  
+4. [Dynamic Configuration](/knowledge-base/proxy/traefik/dynamic-config) -> Manage dynamic configuration changes like routing rules or middlewares.
 
-6. [Load Balancing](/knowledge-base/proxy/traefik/load-balancing) -> Distribute traffic across multiple app instances for better performance.  
+5. [Health Checks](/knowledge-base/health-checks) -> Configure health checks to ensure your applications are running smoothly.
 
-7. [Redirects](/knowledge-base/proxy/traefik/redirects) -> Set up HTTP-to-HTTPS redirection or create specific URL redirects.  
+6. [Load Balancing](/knowledge-base/proxy/traefik/load-balancing) -> Distribute traffic across multiple app instances for better performance.
 
-8. [Wildcard Certificates](/knowledge-base/proxy/traefik/wildcard-certs) -> Secure multiple subdomains with a single SSL certificate.  
+7. [Redirects](/knowledge-base/proxy/traefik/redirects) -> Set up HTTP-to-HTTPS redirection or create specific URL redirects.
+
+8. [Wildcard Certificates](/knowledge-base/proxy/traefik/wildcard-certs) -> Secure multiple subdomains with a single SSL certificate.
 
 ---
 
 ::: danger CAUTION!  
-  **Do not make changes to Traefik's configuration unless you are sure of what you are doing. Incorrect settings can make your entire application inaccessible..**  
+ **Do not make changes to Traefik's configuration unless you are sure of what you are doing. Incorrect settings can make your entire application inaccessible..**
 
-  **We highly recommend testing any changes in a development environment before applying them to production.**
-:::  
+**We highly recommend testing any changes in a development environment before applying them to production.**
+:::

docs/knowledge-base/proxy/traefik/overview.md

@@ -1,27 +1,30 @@
 ---
-title: Bad Gateway Error 
+title: Bad Gateway Error
 ---
 
 # Bad Gateway Error
+
 If your deployed application **maybe** works when you access it via your server’s IP address and port but shows a **Bad Gateway** error on your domain, the issue is most often due to misconfigured port settings, incorrect host mapping, or your app listening only on localhost.
 
 ## What’s an Application and What's a Service?
+
 - **Application:** An Application is deployed by you using a Git repository or any deployment option **except** the one-click service.
 
 - **Service:** A Service is an app deployed using a Compose file or the one-click service on Coolify. These deployments may have different network settings and UI sections (for example, you might not see the Network section in your UI).
 
-
 ## Symptoms
-- The application **maybe** accessible via the server IP with a port number but not via the domain.
-- You might also run into a **No Available Server** error.
 
+- The application **maybe** accessible via the server IP with a port number but not via the domain.
 
 ## Diagnosis
-- **Port Configuration:**  
-  - **Applications:** Make sure the port your app is listening on is correctly entered in the **Port Exposes** field on the Coolify dashboard.  
+
+- **Port Configuration:**
+
+  - **Applications:** Make sure the port your app is listening on is correctly entered in the **Port Exposes** field on the Coolify dashboard.
   - **Services:** Check that your Compose or one-click service configuration has the appropriate network configuration.
 
-- **Host Mapping:**  
+- **Host Mapping:**
+
   - **Applications:** Verify that the application’s port is not incorrectly mapped to the host system.
   - **Services:** Confirm that any port mapping in your Compose file or service configuration aligns with the proxy routing requirements.
 
@@ -31,28 +34,27 @@ If your deployed application **maybe** works when you access it via your server
 
 - **Container Status:** Check the status of the container where your app or service is running. Is it unhealthy? Stuck at Starting? A failing health check might be the reason.
 
-
 ## Solution
-- **Update Port Settings:** Enter the correct port number in the **Port Exposes** field on the Coolify dashboard and restart your app.  
-    
+
+- **Update Port Settings:** Enter the correct port number in the **Port Exposes** field on the Coolify dashboard and restart your app.
+
     <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/1.webp" />
 
-- **Remove Host Port Mapping:** If the port is mapped to the host system, remove the mapping so the proxy can route traffic correctly, then restart your app.  
-    
+- **Remove Host Port Mapping:** If the port is mapped to the host system, remove the mapping so the proxy can route traffic correctly, then restart your app.
+
     <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/2.webp" />
 
-- **Adjust Listening Address:** Change your application so it listens on all network interfaces (`0.0.0.0`) instead of just `localhost`.  
-    
+- **Adjust Listening Address:** Change your application so it listens on all network interfaces (`0.0.0.0`) instead of just `localhost`.
+
     <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/3.webp" />
 
 - **Correct Domain URL:** Add the correct port number at the end of your domain URL if needed, and restart your application.
-  
-    <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/4.webp" />
 
-- **Restart Container / Check Logs:** Restart the container or check its logs to diagnose the issue. Often, a failing health check might be the problem, and removing the health check could fix it.
-  
-    <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/5.webp" />
+    <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/4.webp" />
 
+- **Restart Container / Check Logs:** Restart the container or check its logs to diagnose the issue.
+  <ZoomableImage src="/docs/images/troubleshoot/applications/bad-gateway/5.webp" />
 
 ## Support
-If these steps don’t solve the issue, consider reaching out for further assistance by joining our [Discord community ↗](https://coolify.io/discord) and sharing your app logs, coolify proxy logs, configuration screenshots, and details of the troubleshooting steps you’ve already tried.
+
+If these steps don’t solve the issue, consider reaching out for further assistance by joining our [Discord community ↗](https://coolify.io/discord) and sharing your app logs, coolify proxy logs, configuration screenshots, and details of the troubleshooting steps you’ve already tried.