+ +Docker Compose lets you deploy multiple Docker containers and configure them easily. + +With the Docker Compose build pack, you can use your own Docker Compose file (i.e. `docker-compose.y[a]ml`) as the single source of truth, giving you full control over how your application is built and deployed on Coolify. + +## How to use Docker Compose? + +### 1. Create a New Resource in Coolify + +On the Coolify dashboard, open your project and click the **Create New Resource** button. + +
+
+
diff --git a/content/docs/applications/build-packs/dockerfile.mdx b/content/docs/applications/build-packs/dockerfile.mdx
new file mode 100644
index 00000000..dd6d4fe1
--- /dev/null
+++ b/content/docs/applications/build-packs/dockerfile.mdx
@@ -0,0 +1,136 @@
+---
+title: Dockerfile Build Pack
+description: Build Docker images from your custom Dockerfile with Coolify supporting Git repositories, environment variables, and pre/post-deployment commands.
+---
+
+1. Visiting the Application Domain Shows "No Available Server"
+ +If you see a "No Available Server" error when visiting your website, it is likely due to the health check for your container. + +Run `docker ps` on your server terminal to check if your container is unhealthy or still starting. + +To resolve this, fix the issue causing the container to be unhealthy or remove the health checks. + ++ +Dockerfile includes step-by-step instructions to build a Docker image that Coolify uses to deploy your application or website. + +The Dockerfile build pack allows you to use your own Dockerfile to deploy your application, you have complete control over how your application is built and deployed on Coolify. + +## How to use Dockerfile? + +### 1. Create a New Resource in Coolify + +On the Coolify dashboard, open your project and click the **Create New Resource** button. + +
+
+
+
+
+1. Visiting the Application Domain Shows "No Available Server"
+ +If you see a "No Available Server" error when visiting your website, it is likely due to the health check for your container. + +Run `docker ps` on your server terminal to check if your container is unhealthy or still starting. + +To resolve this, fix the issue causing the container to be unhealthy or remove the health checks. + +
+
+
diff --git a/content/docs/applications/build-packs/index.mdx b/content/docs/applications/build-packs/index.mdx
new file mode 100644
index 00000000..26bd2663
--- /dev/null
+++ b/content/docs/applications/build-packs/index.mdx
@@ -0,0 +1,54 @@
+---
+title: Build Packs
+description: Choose from Nixpacks, Static, Dockerfile, or Docker Compose build packs to create optimized Docker images for your application deployments.
+---
+
+2. App only works inside the Container
+ +If your app works when you check it with a `curl localhost` inside the container but you receive a 404 or "No Available Server" error when accessing your domain, verify the port settings. + +Make sure that the port in the network settings matches the port where your application is listening. Also, check the startup log to ensure the application is not only listening on localhost. + ++ +Coolify deploys every application as a Docker container. This means your application runs in its own isolated container. + +To run a container, you need a Docker image built from your source code. + +Build packs helps to create this Docker image and manage the build and deployment process. + + +## Why Use Build Packs? + +- **Simplifies the Build Process:** Some Build packs automatically create the Docker image needed for deployment, so you don’t have to spend time on learning how to write Dockerfiles on your own. + +- **Flexibility for Different Projects:** Since every application is different, you can choose a build pack that suits your specific needs, whether you prefer an automated solution or a custom configuration. + + +## How Build Packs Work + +Each build pack offers a different approach to building your Docker image: + +- **Automated Dockerfile Creation:** Build packs like Nixpacks & Static Build Pack automatically generate a Dockerfile based on your codebase and builds the docker image. + - This allows you to deploy your application quickly without having to write the Dockerfile yourself. + +- **Custom Dockerfile or Docker Compose:** Build packs like Dockerfile & Docker Compose let you use a Dockerfile or Docker Compose file that you have already have on your codebase. + - This gives you full control over how your Docker image is built and how multiple services work together. + + +## Choose the Right Build Pack + +Coolify have four build packs to meet different requirements: +- **Nixpacks:** Good for quick and automated Docker image creation with minimal configuration. + +- **Static Build Pack:** Perfect for static sites and simple applications that don’t need server-side processing. + +- **Dockerfile:** Use your own Dockerfile, if you want full control over the docker image build process. + +- **Docker Compose:** Perfect to Deploy complex, multi-service applications using your custom Docker Compose file. + + +## How to use a Build Pack + +Each build pack has its own step-by-step guide to help you use them in Coolify. Click the links below to learn more about each build pack. + +- [Static Build Pack](/applications/build-packs/static) +- [Nixpack](/applications/build-packs/nixpacks) +- [Dockerfile](/applications/build-packs/dockerfile) +- [Docker Compose](/applications/build-packs/docker-compose) diff --git a/content/docs/applications/build-packs/meta.json b/content/docs/applications/build-packs/meta.json new file mode 100644 index 00000000..9edad021 --- /dev/null +++ b/content/docs/applications/build-packs/meta.json @@ -0,0 +1,9 @@ +{ + "title": "Build Packs", + "pages": [ + "static", + "nixpacks", + "dockerfile", + "docker-compose" + ] +} \ No newline at end of file diff --git a/content/docs/applications/build-packs/nixpacks/index.mdx b/content/docs/applications/build-packs/nixpacks/index.mdx new file mode 100644 index 00000000..4667b65e --- /dev/null +++ b/content/docs/applications/build-packs/nixpacks/index.mdx @@ -0,0 +1,171 @@ +--- +title: Nixpacks Build Pack +description: Build applications with Nixpacks automatic buildpack detecting your codebase, generating Dockerfiles, and deploying static sites or dynamic apps. +--- + +
+ +Nixpacks is a open source build pack created by [Railway](https://railway.com?utm_source=coolify.io) and the source is available on [Github](https://github.com/railwayapp/nixpacks?utm_source=coolify.io). Coolify uses Nixpacks as one of the build pack. + +Nixpacks checks your git repository (also called as "**source directory**" in nixpacks) and generates a Dockerfile, then it will build a docker image based on the Dockerfile it generated. + +Nixpacks can deploy both fully static websites and non-static applications. Once your repository is set up, you can use Coolify to deploy your project with ease. + +## How to use Nixpacks? + +On Coolify you can only use Nixpacks on git-based deployments. + +### 1. Create a New Resource in Coolify + +On Coolify dashboard open your project and click the **Create New Resource** button. + +
+ +Static Build Packs take the files from your project and create a Docker image with a web server to serve them. This means your final Docker image has a web server ready to display your HTML, CSS, and JavaScript files. + +Static Build Packs only work if your project is already built (for example, with a static site generator like [Astro](https://astro.build/?utm_source=coolify.io) or [Webstudio](https://webstudio.is/?utm_source=coolify.io)). Once you have the built files, you can upload them to a Git repository and use Coolify to deploy your site. + +## How to Use Static Build Pack + +### 1. Prepare Your Static Files + +First, build your site with your favorite static site generator. This process creates a folder with all the files your site needs (HTML, CSS, JavaScript, etc.). + +Next, upload these static files to a Git repository. You can use [GitHub](https://github.com/?utm_source=coolify.io), [GitLab](https://about.gitlab.com/?utm_source=coolify.io), or any other Git service. For this guide, we will use [GitHub](https://github.com/?utm_source=coolify.io) as an example. + +### 2. Create a New Resource in Coolify + +On Coolify dashboard open your project and click the **Create New Resource** button. + +
{{random}} to generate a random subdomain each time a PR is deployed.
+ - Use {{pr_id}} to use the pull request ID as the subdomain.
+
+
++ +[Coolify Cloud](https://coolify.io/pricing/) is our managed, paid service (maintained by [Andras](https://x.com/heyandras), Coolify’s Founder) that runs the Coolify on our infrastructure, so you don’t need to allocate CPU, RAM, or disk for Coolify itself. + +You still bring your own servers (VPS, Raspberry Pi, EC2, etc.) and connect them via SSH, then deploy apps, databases, and services exactly as you would with a self-hosted instance. + +Coolify Cloud uses the same open-source codebase, so there are no locked-behind-paywall features. + +## Benefits of Coolify Cloud + +| Features | Explanation | +| :--------------------------- | :------------------------------------------------------------------------------------------------------------------ | +| **Zero Maintenance Coolify** | No need to upgrade, or monitor Coolify, our team does it for you. | +| **Daily Backups** | The Coolify Cloud database is backed up every 24 hours. | +| **Preconfigured Email** | Receive build, deployment, and server status notifications via email without any setup on your end. | +| **Automatic Scaling** | As you connect more servers, our infrastructure scales CPU, RAM, and disk usage for Coolify. | +| **Staged Updates** | New updates are first rolled out to self-hosted users. Once stability is confirmed, they’re rolled out to Cloud. | +| **Founder-Tested Releases** | Andras personally tests every update before it’s deployed to the Cloud, ensuring maximum stability and reliability. | + +## Getting Started with Coolify Cloud + +1. **Create Your Account:** + + - Visit the [Coolify Cloud Registration](https://app.coolify.io/register) page and sign up. + +2. **Choose Your Plan:** + + - Base fee: **$5/month** (includes up to two connected servers). + - **$3/month** per additional server. + +3. **Complete Payment** + + - Use any major credit/debit card to finish the subscription process. + +4. **Connect Your Servers** + + +
+
+
+
+
+
+5. **Deploy Your Applications**
+
+## How Coolify Cloud Pricing works?
+
+We charge a base fee of **\$5/month**, which covers up to **two servers**. Each additional server you connect is an **add-on of \$3/month**.
+
+Charging per server allows us to scale our infrastructure responsibly, since each connected server increases resource usage (CPU, RAM, storage) on our end.
+
+If you only need one server, you still pay the $5 base fee (with capacity for a second server if you add it later).
+
+If you plan to connect more than two, simply multiply $3 by the extra servers.
+
+## Why Coolify Cloud Exists
+
+You might wonder why Coolify Cloud is a paid service when there are no exclusive, locked-down features.
+
+The idea came to Andras (Coolify's Founder) as a way to offer a “**paid option without paywall**” — a model where the open-source project stays completely free, but those who prefer a managed experience can contribute financially.
+
+- **Experiment Turned Success:**
+ - Initially launched as an experiment, Coolify Cloud quickly attracted over 2,100 active users.
+
+* **Sustainable Funding:**
+
+ - While the revenue from Cloud is modest, it provides a steady income stream that helps keep Coolify free and under active development for everyone.
+
+* **Community-First Approach**
+ - By not restricting any features, we maintain transparency and trust.
+ - Cloud subscribers simply pay for convenience and reliability, not to unlock core functionality.
+
+## Frequently Asked Questions
+
+
+Detailed Server Connection Guide
+ + 1. **Add Private Key:** Login to your Coolify account (or create one if you’re new) and Add a new private key ++
+
+
+
+
+1. Do I get any Cloud-only features?
+ +No. Coolify Cloud and self-hosted Coolify share the same feature set. + +Cloud’s value lies in automatic backups, email notifications, scaling, and update testing handled for you. + +
+
+
+
+2. Does Coolify Cloud back up my application data?
+ +No, Coolify Cloud only backs up the Coolify database (e.g., dashboard settings). + +You are responsible for backing up any databases or storage volumes on your servers. + +
+
+
+
+3. Can I import my self-hosted Coolify configurations to Coolify Cloud?
+ +No. + +To transfer configurations, you'll need to back up the database from your self-hosted instance and restore it to a new Coolify instance. + +However, since you don’t have access to the database in Coolify Cloud, it’s not possible to migrate data or settings directly to the cloud version. + +
+
+
+
+4. How often Coolify Cloud is backed up?
+ +Every 24 hours + +
+
+
+
+5. Is Coolify Cloud really based on the open-source version of Coolify?
+ +Yes, Coolify Cloud uses the same open-source codebase as the self-hosted version. There are no paywall features, and the Cloud service is simply a managed experience for convenience. + +
+
+
+
+6. What happens if I cancel my Coolify Cloud subscription?
+ +If you cancel your subscription, you will stop being billed, and your access to Coolify Cloud will be suspended at the end of your current billing cycle. + +However, your servers will remain unaffected, and all of your applications will continue running as normal. + +Since your server will still be hosting your applications with a reverse proxy handling incoming requests, there will be no interruptions. + +
+
+
+
+
+7. What happens if I forget to pay an invoice?
+ +If a payment fails or an invoice is missed, your subscription and access to Coolify Cloud will be temporarily paused until the payment is successfully processed. + +You will receive an email notification about the failed payment. + +Once the payment is made, your Coolify Cloud access will be restored, and all your settings will remain intact—there’s no data loss. + +Your servers will also stay up and running, and your applications will continue to function normally, as everything is still hosted on your own server with a reverse proxy. + +
+
+
+
+8. Are there any IP addresses I need to whitelist for Coolify Cloud?
+ +Yes, Coolify Cloud uses specific IP addresses. + +You can find the list of IPs [here](https://coolify.io/docs/knowledge-base/faq#coolify-cloud-public-ips). + +The main requirement is that Coolify Cloud needs to access your server's SSH port. + +
+
+
+
+9. Do I need to bring my own servers to Coolify Cloud?
+ +Yes, when using Coolify Cloud, you must provide your own servers (e.g., VPS, Raspberry Pi, EC2, etc.). + +Coolify Cloud manages Coolify on our infrastructure, but we don’t provide the servers themselves. + +This approach allows you to choose the hardware that best fits your needs. + +
+
+
+
+10. Why do I have to pay for Coolify Cloud if I’m bringing my own servers?
+ +While you bring your own servers, the subscription fee for Coolify Cloud covers the managed service aspect. + +This includes infrastructure management, maintenance, support, updates, and scaling, so you don’t have to worry about technical aspects like monitoring, patching, or backups for Coolify. + +We take care of the heavy lifting to ensure everything runs smoothly. + +
+
+
+
+11. What happens if I exceed the number of connected servers?
+ +You won’t be able to add extra servers to Coolify cloud unless your subscription is upgraded. + +
+
+
+
+12. Is there a trial period for Coolify Cloud?
+ +Currently, Coolify Cloud doesn’t offer a free trial. However, the subscription is affordable—just **$5 per month** for up to two connected servers. + +If you want to explore all the features, you can run Coolify on a small Linux server or a VM on your PC by following the [self-hosted installation guide](https://coolify.io/docs/get-started/installation). + +Since both cloud and self-hosted versions use the same codebase, you’ll be able to test all the features without any limitations. + +
+
+
+
+13. Can I get any discounts?
+ +The current **$5/month** subscription rate is already quite affordable, so discounts are not available at the moment. + +
+
+
+
+14. I have to pay to use Coolify Cloud, so doesn't that mean I'm locked into a vendor?
+ +**Not really.** + +You're paying for the managed Coolify instance, but stopping the use of Coolify Cloud won't affect your applications. + +You can connect your own server, so you retain full control. Everything runs as a Docker container, and Coolify will install a reverse proxy on your server to ensure everything works smoothly without needing Coolify Cloud. + +In a true vendor lock-in, your apps would stop if you stop paying, but that’s not the case with Coolify Cloud. + +
+
+
diff --git a/content/docs/get-started/concepts.mdx b/content/docs/get-started/concepts.mdx
new file mode 100644
index 00000000..46a75f9c
--- /dev/null
+++ b/content/docs/get-started/concepts.mdx
@@ -0,0 +1,80 @@
+---
+title: Coolify Concepts
+description: Learn core Coolify concepts including servers, resources, environments, projects, Docker containers, reverse proxy, and team management basics.
+---
+
+15. Can I access the Coolify Cloud dashboard on my own domain?
+ +No. + +The Coolify Cloud dashboard is only available at https://app.coolify.io. + +If you’d like to access the dashboard on your own domain, you’ll need to self-host Coolify. + ++ +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. + +## Servers + +A server is a computer designed to run applications or services, providing the necessary computing power for your projects. + +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. + +## Resources + +In Coolify, a resource refers to an application or service you set up on your server—like a website, database, or API. + +Each resource comes with its own configuration, like domains, backups, health checks, and so on. + +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. + +## Environments + +In Coolify, a environment is a tailored setup on your server that determines how your resources operate. + +For instance, you could have a development environment for testing and debugging your code, alongside a production environment where your finished application goes live. + +With Coolify, you can set up multiple environments on a single server, letting you switch between them effortlessly. + +## Projects + +A project in Coolify is a group of environments and resources you’ve deployed on your server. + +It serves as the highest-level structure in Coolify, organizing your deployment setup. + +You can manage multiple projects on the same server, each with its own unique set of environments and resources. + +For example, you might create one project for all your hobby-related resources and another for work-related ones. + +## Containers + +In Coolify, everything you deploy runs as a Docker container, making it easy to manage and isolate your application. + +You can use pre-built Docker images from public registries like Docker Hub or GitHub Container Registry to deploy without building them yourself. + +To deploy, you need a Docker image, either one you’ve built or one from someone else. + +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. + +Alternatively, you can build the image elsewhere, push it to a registry, and let Coolify deploy it as a container. + +## Reverse Proxy + +A reverse proxy is a server or app that sits between your application and users, forwarding requests to the right place. + +Coolify includes two proxy options, Caddy and Traefik, which handle requests to your website by directing them to the container running your app. + +This setup lets you run multiple applications on one server without tweaking configs or ports. + +Plus, Coolify supports unlimited domains, so you could deploy 20 different apps, each with its own unique domain. + +The reverse proxy also automatically manages SSL/TLS certificates for your applications. When you enter a domain with `https://`, the proxy requests and installs certificates from [Let's Encrypt](https://letsencrypt.org?utm_source=coolify.io) automatically, with no manual configuration needed. Certificates are renewed automatically before they expire, keeping your applications secure without any intervention. + +## Security + +Coolify doesn’t manage your server’s security or updates, that’s your responsibility to keep everything secure and up to date. + +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. + +## Teams + +Coolify supports multiple users and teams, allowing each team to have its own projects and environments. + +You can assign roles like admin to users, simplifying project management and collaboration on a single server. + +Currently, the teams feature isn’t fully polished for production use, but the Coolify core team plans to enhance it down the line. diff --git a/content/docs/get-started/contribute/coolify.mdx b/content/docs/get-started/contribute/coolify.mdx new file mode 100644 index 00000000..2e099cc2 --- /dev/null +++ b/content/docs/get-started/contribute/coolify.mdx @@ -0,0 +1,282 @@ +--- +title: Contributing to Core Coolify +description: Contribute to Coolify open-source development with step-by-step setup guide, Docker environment, Spin commands, and pull request workflow. +--- + +# Contributing to Coolify +> "First, thanks for considering contributing to my project. It really means a lot!" - [@andrasbacsai](https://github.com/andrasbacsai) + +You can ask for guidance anytime on our [Discord Community Server](https://coollabs.io/discord) in the `#contribute` channel. + +To understand the tech stack, please refer to the [Tech Stack](https://github.com/coollabsio/coolify/blob/main/TECH_STACK.md) document. + + +## Table of Contents +1. [Setup Development Environment](#_1-setup-development-environment) +2. [Verify Installation](#_2-verify-installation-optional) +3. [Fork and Setup Local Repository](#_3-fork-and-setup-local-repository) +4. [Set up Environment Variables](#_4-set-up-environment-variables) +5. [Start Coolify](#_5-start-coolify) +6. [Start Development](#_6-start-development) +7. [Create a Pull Request](#_7-create-a-pull-request) +8. [Development Notes](#development-notes) +9. [Resetting Development Environment](#resetting-development-environment) +10. [Additional Contribution Guidelines](#additional-contribution-guidelines) + + +## 1. Setup Development Environment +Follow the steps below for your operating system: + +
+
+
+Windows
+ +1. Install `docker-ce`, Docker Desktop (or similar): + - Docker CE (recommended): + - Install Windows Subsystem for Linux v2 (WSL2) by following this guide: [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install?ref=coolify) + - After installing WSL2, install Docker CE for your Linux distribution by following this guide: [Install Docker Engine](https://docs.docker.com/engine/install/?ref=coolify) + - Make sure to choose the appropriate Linux distribution (e.g., Ubuntu) when following the Docker installation guide + - Install Docker Desktop (easier): + - Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/?ref=coolify) + - Ensure WSL2 backend is enabled in Docker Desktop settings + +2. Install Spin: + - Follow the instructions to install Spin on Windows from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-windows#download-and-install-spin-into-wsl2?ref=coolify) + +
+
+
+MacOS
+ +1. Install Orbstack, Docker Desktop (or similar): + - Orbstack (recommended, as it is a faster and lighter alternative to Docker Desktop): + - Download and install [Orbstack](https://docs.orbstack.dev/quick-start#installation?ref=coolify) + - Docker Desktop: + - Download and install [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/?ref=coolify) + +2. Install Spin: + - Follow the instructions to install Spin on MacOS from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-macos/#download-and-install-spin?ref=coolify) + +
+
+
+
+## 2. Verify Installation (Optional)
+After installing Docker (or Orbstack) and Spin, verify the installation:
+
+1. Open a terminal or command prompt
+2. Run the following commands:
+ ```bash
+ docker --version
+ spin --version
+ ```
+ You should see version information for both Docker and Spin.
+
+
+## 3. Fork and Setup Local Repository
+1. Fork the [Coolify](https://github.com/coollabsio/coolify) repository to your GitHub account.
+
+2. Install a code editor on your machine (choose one):
+
+ | Editor | Platform | Download Link |
+ |--------|----------|---------------|
+ | Visual Studio Code (recommended free) | Windows/macOS/Linux | [Download](https://code.visualstudio.com/download?ref=coolify) |
+ | Cursor (recommended but paid) | Windows/macOS/Linux | [Download](https://www.cursor.com/?ref=coolify) |
+ | Zed (very fast) | Windows/macOS/Linux | [Download](https://zed.dev/download?ref=coolify) |
+
+3. Clone the Coolify Repository from your fork to your local machine
+ - Use `git clone` in the command line, or
+ - Use GitHub Desktop (recommended):
+ - Download and install from [https://desktop.github.com/](https://desktop.github.com/?ref=coolify)
+ - Open GitHub Desktop and login with your GitHub account
+ - Click on `File` -> `Clone Repository` select `github.com` as the repository location, then select your forked Coolify repository, choose the local path and then click `Clone`
+
+4. Open the cloned Coolify Repository in your chosen code editor.
+
+
+## 4. Set up Environment Variables
+1. In the Code Editor, locate the `.env.development.example` file in the root directory of your local Coolify repository.
+2. Duplicate the `.env.development.example` file and rename the copy to `.env`.
+3. Open the new `.env` file and review its contents. Adjust any environment variables as needed for your development setup.
+4. If you encounter errors during database migrations, update the database connection settings in your `.env` file. Use the IP address or hostname of your PostgreSQL database container. You can find this information by running `docker ps` after executing `spin up`.
+5. Save the changes to your `.env` file.
+
+
+## 5. Start Coolify
+1. Open a terminal in the local Coolify directory.
+2. Run the following command in the terminal (leave that terminal open):
+ ```bash
+ spin up
+ ```
+
+
+Linux
+ +1. Install Docker Engine, Docker Desktop (or similar): + - Docker Engine (recommended, as there is no VM overhead): + - Follow the official [Docker Engine installation guide](https://docs.docker.com/engine/install/?ref=coolify) for your Linux distribution + - Docker Desktop: + - If you want a GUI, you can use [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/?ref=coolify) + +2. Install Spin: + - Follow the instructions to install Spin on Linux from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-linux#configure-docker-permissions?ref=coolify) + ++ +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). + +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. + + +
+ +If you decide to go with **Coolify Cloud**, there's no installation required. Simply visit [Coolify Cloud Registration](https://app.coolify.io/register) to create an account and start using Coolify within minutes! + +Below, you'll find instructions for installing Coolify if you prefer to **self-host** it. + +## Self-hosted Installation + +If you like taking control and managing everything yourself, self-hosting Coolify is the way to go. + +It's completely free (apart from your server costs) and gives you full control over your setup. + + +
+
+
+
+#### 3. Access Coolify
+
+After installation, the script will display your Coolify URL (e.g., `http://203.0.113.1:8000`). Visit this URL, and you'll be redirected to a registration page to create your first admin account.
+
+
+Click to view all available environment variables
+ + +You can set these environment variables before running the installation script to customize your Coolify setup: + +| Environment Variable | Description | Default Value | Example | +| ---------------------------- | ----------------------------------------------------- | ------------- | -------------------- | +| `ROOT_USERNAME` | Predefined root username for first admin account | - | `admin` | +| `ROOT_USER_EMAIL` | Predefined root user email for first admin account | - | `admin@example.com` | +| `ROOT_USER_PASSWORD` | Predefined root user password for first admin account | - | `SecurePassword123!` | +| `DOCKER_ADDRESS_POOL_BASE` | Custom Docker address pool base (CIDR notation) | `10.0.0.0/8` | `172.16.0.0/12` | +| `DOCKER_ADDRESS_POOL_SIZE` | Custom Docker address pool size (must be 16-28) | `24` | `20` | +| `DOCKER_POOL_FORCE_OVERRIDE` | Force override existing Docker pool configuration | `false` | `true` | +| `AUTOUPDATE` | Enable/disable automatic Coolify updates | `true` | `false` | +| `REGISTRY_URL` | Custom Docker registry URL for Coolify images | `ghcr.io` | `your-registry.com` | + +**Usage Examples:** + +**1. Create Admin Account During Installation:** + +```bash +env ROOT_USERNAME=admin \ +ROOT_USER_EMAIL=admin@example.com \ +ROOT_USER_PASSWORD=SecurePassword123 \ +bash -c 'curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash' +``` + +See the [Create Root User with Environment Variables](/knowledge-base/create-root-user-with-env) guide for more details. + +**2. Custom Docker Network Pool:** + +```bash +env DOCKER_ADDRESS_POOL_BASE=172.16.0.0/12 \ +DOCKER_ADDRESS_POOL_SIZE=20 \ +bash -c 'curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash' +``` + +See the [Define Custom Docker Network with ENV](/knowledge-base/define-custom-docker-network-with-env) guide for more details. + +**3. Disable Auto-Updates:** + +```bash +env AUTOUPDATE=false \ +bash -c 'curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash' +``` + +**4. Use Custom Docker Registry:** + +```bash +env REGISTRY_URL=your-registry.com \ +bash -c 'curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash' +``` + +When using a custom registry, make sure all required Coolify images are available in your registry. + +**5. Combine Multiple Variables:** + +```bash +env ROOT_USERNAME=admin \ +ROOT_USER_EMAIL=admin@example.com \ +ROOT_USER_PASSWORD=SecurePassword123 \ +AUTOUPDATE=false \ +DOCKER_ADDRESS_POOL_BASE=172.16.0.0/12 \ +bash -c 'curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash' +``` + + ++ +## What is Coolify? + +Coolify is a software that makes self-hosting simple and powerful. It lets you run your applications, databases, and services on your own server, whether that’s an old laptop, a Raspberry Pi, or a rented server from a provider like [Hetzner](https://coolify.io/hetzner). + +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. + +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. + +### What Coolify Is Not + +Coolify isn’t a cloud service that hosts everything for you, you need your own server. That could be your old laptop, a Raspberry Pi, or a rented server from a hosting provider like [Hetzner](https://coolify.io/hetzner), and you’ll need SSH access to use it. + +It’s not a zero-effort solution either, if you choose to self-host, you’ll need to set up your server and install Coolify. But once it’s running, managing your projects becomes very easy. + +## Features of Coolify + +Coolify is loaded with tools to make self-hosting smooth and powerful. Here’s a detailed look at what it offers: + +| Features | Explanation | +| :------------------------ | :-------------------------------------------------------------------------------------------------------- | +| **Any Language** | Deploy static sites, APIs, backends, databases, and more with support for all major frameworks. | +| **Any Server** | Deploy to any server - VPS, Raspberry Pi, EC2, your laptop via SSH. | +| **Any Use-Case** | Supports single servers, multi-server setups, and Docker Swarm clusters (Kubernetes support coming soon). | +| **Any Service** | Deploy any Docker-compatible service, plus a wide range of one-click options. | +| **Push to Deploy** | Git integration with GitHub, GitLab, Bitbucket, Gitea, and other platforms. | +| **Free SSL Certificates** | Automatically sets up and renews Let's Encrypt SSL certificates for custom domains. | +| **No Vendor Lock-In** | Your data and settings stay on your servers for full control and easy portability. | +| **Automatic Backups** | Back up data to S3-compatible storage and restore it with one click if needed. | +| **Webhooks** | Integrate with CI/CD tools like GitHub Actions, GitLab CI, or Bitbucket Pipelines. | +| **Powerful API** | Automate deployments, manage resources, and integrate with your existing tools easily. | +| **Real-Time Terminal** | Run server commands directly from your browser in real-time. | +| **Collaborative** | Share projects with your team, control roles, and manage permissions. | +| **PR Deployments** | Deploy commits and pull requests separately for quick reviews and faster teamwork. | +| **Server Automations** | Handles server setup tasks automatically after connection, saving you time. | +| **Monitoring** | Monitor deployments, servers, disk usage, and receive alerts for issues. | + +## Benefits of Using Coolify + +Coolify delivers unbeatable advantages for developers who want to self-host. Here’s why it stands out: + +| Benefits | Explanation | +| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Cost Savings** | Avoid skyrocketing cloud costs. Use your own server for a steady, predictable price. | +| **No Hidden Costs** | Transparent pricing with no unexpected charges. | +| **Highly Cost-Efficient** | Save thousands monthly compared to traditional cloud platforms. Real examples can be found [here](https://twitter.com/heyandras/status/1742078215986860460), [here](https://twitter.com/heyandras/status/1752209429276086688), and [here](https://twitter.com/heyandras/status/1724510876256944244) | +| **Complete Data Privacy** | Your data stays on your server, ensuring total control and security. | +| **No Feature Restrictions** | All features are included in the open-source version—nothing locked behind a paywall. | +| **Unlimited Usage** | Deploy unlimited websites and applications across any number of servers. | +| **Quick Setup** | Start hosting in minutes with minimal maintenance required. | +| **User-Friendly Interface** | Manage your infrastructure through a clean, simple dashboard designed for developers. | +| **100% Open Source** | Review the code, contribute to development, and help shape the platform’s future. | +| **Active Community** | Join over 16,000 people on Discord and 204,000+ servers running Coolify worldwide. | + +## Getting Started with Coolify + +Before you jump into using Coolify, it’s worth understanding a few key concepts to make your journey smoother. + +Learn about servers, SSH access, and how Coolify manages your projects by checking out our [concepts guide](/get-started/concepts). + +You have two ways to use Coolify: + +- [Self-Host Coolify](#self-host-coolify) +- [Use Coolify Cloud](#use-coolify-cloud) + +--- + +### Self-Host Coolify + +- Install Coolify on your own server. This requires setting up the server, installing Coolify, and handling updates yourself. +- You’ll also need to allocate some server resources to run Coolify. +- It’s completely free (except your server bills) and gives you full control over your infrastructure. + +### Use Coolify Cloud + +- Let the Coolify team manage Coolify for you. +- With Coolify Cloud, you don’t need to install or update Coolify yourself, and no server resources are required for Coolify itself, it runs on the Coolify team’s managed servers. +- Simply create an account from [here](https://app.coolify.io/register), connect your servers via SSH keys, and start deploying. + This is a paid service (starting at $5/mo), as it costs the team to host and maintain the infrastructure. +- Updates on Coolify Cloud are thoroughly tested by the core team, so they might be slightly delayed for added stability. + +## Join Our Community + +Got questions or need support? Our [discord community](https://coollabs.io/discord) is here to help. +Connect with other Coolify users on our community server to get assistance and share your experiences. diff --git a/content/docs/get-started/meta.json b/content/docs/get-started/meta.json new file mode 100644 index 00000000..7b42108f --- /dev/null +++ b/content/docs/get-started/meta.json @@ -0,0 +1,19 @@ +{ + "title": "Get Started", + "pages": [ + "introduction", + "installation", + "upgrade", + "downgrade", + "uninstallation", + "cloud", + "usage", + "concepts", + "screenshots", + "videos", + "team", + "support", + "sponsors", + "contribute" + ] +} \ No newline at end of file diff --git a/content/docs/get-started/screenshots.mdx b/content/docs/get-started/screenshots.mdx new file mode 100644 index 00000000..756008f0 --- /dev/null +++ b/content/docs/get-started/screenshots.mdx @@ -0,0 +1,63 @@ +--- +title: Coolify UI Screenshots +description: View screenshots of Coolify's user interface showing dashboard, deployment options, server management, and application configuration features. +--- + + +# Coolify UI Screenshots +The Coolify team is currently developing a brand new UI design. Below are the images showing the current UI. + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+
+
diff --git a/content/docs/get-started/support.mdx b/content/docs/get-started/support.mdx
new file mode 100644
index 00000000..2728faff
--- /dev/null
+++ b/content/docs/get-started/support.mdx
@@ -0,0 +1,25 @@
+---
+title: Support
+description: Get Coolify support through Discord community with 19K+ members, direct email support for Cloud users, and core team developer assistance.
+---
+
+
+ 
+
+
+
+
+
+
+Hetzner
+Server, cloud, hosting, and data center solutions
+
+ 
+
+
+
+
+
+
+Logto
+The better identity infrastructure for developers
+
+ 
+
+
+
+
+
+
+Tolgee
+The open source localization platform
+
+ 
+
+
+
+
+
+
+Best Consultant
+Your trusted technology consulting partner
+
+ 
+
+
+
+
+
+
+QuantCDN
+Enterprise-grade content delivery network
+
+ 
+
+
+
+
+
+
+Arcjet
+Advanced web security and performance solutions
+
+ 
+
+
+
+
+
+
+SupaGuide
+Your comprehensive guide to Supabase
+
+ 
+
+
+
+
+
+
+CodeRabbit
+Cut Code Review Time & Bugs in Half
+
+ 
+
+
+
+
+
+
+Convex
+Open-source reactive database for web app developers
+
+ 
+
+
+
+
+
+
+GoldenVM
+Premium virtual machine hosting solutions
+
+ 
+
+
+
+
+
+
+Tigris
+Modern developer data platform
+
+ 
+
+
+
+
+
+
+Cloudify
+Cloud hosting solutions
+
+ 
+
+
+
+
+
+
+Trieve
+AI-powered search and analytics
+
+ 
+
+
+
+
+
+
+Blacksmith
+Infrastructure automation platform
+
+ 
+
+
+
+
+
+
+Comit International
+New York Times award–winning contractor!
+
+ 
+
+
+
+
+
+
+Brand.dev
+The #1 Brand API for B2B software startups
+
+ 
+
+
+
+
+
+
+Syntax.fm
+Podcast for web developers
+
+ 
+
+
+
+
+
+
+Jobs Collider
+30,000+ remote jobs for developers
+
+ 
+
+
+
+
+
+
+Hostinger
+Web hosting and VPS solutions
+
+ 
+
+
+
+
+
+
+GlueOps
+DevOps automation and infrastructure management
+
+ 
+
+
+
+
+
+
+Ubicloud
+Open source cloud infrastructure platform
+
+ 
+
+
+
+
+
+
+Pfglabs
+Build Real Projects with Golang
+
+ 
+
+
+
+
+
+
+JuxtDigital
+Digital transformation and web solutions
+
+ 
+
+
+
+
+
+
+SaasyKit
+Complete SaaS starter kit for developers
+
+ 
+
+
+
+
+
+
+MassiveGrid
+Enterprise cloud hosting solutions
+
+ 
+
+
+
+
+
+
+American Cloud
+US-based cloud infrastructure services
+
+ 
+
+
+
+
+
+
+Algora
+Open source contribution platform
+
+ 
+
+
+
+
+
+
+LiquidWeb
+Premium managed hosting solutions
+
+ 
+
+
+
+
+
+
+Yaak
+The API client for modern developers
+
+ 
+
+
+
+
+
+
+Comp AI
+The open-source platform that automates compliance
+
+ 
+
+
+
+
+
+
+Darweb
+Design. Develop. Deliver. Specialized in 3D CPQ Solutions for eCommerce
+
+ 
+
+
+
+
+
+
+WZ-IT
+German agency for customized cloud solutions, migration, managed services and open source hosting
+
+ 
+
+
+
+
+
+
+Supadata
+Scrape YouTube, web, and files. Get AI-ready, clean data for your next project
+
+ 
+
+
+
+
+
+
+Gozunga
+Seriously Simple Cloud Infrastructure
+
+ 
+
+
+
+
+
+Macarne
+Best IP Transit & Carrier Ethernet Solutions for Simplified Network Connectivity
+
+
+
+ 
+
+
+
+
+Your Company?
+Will Your Company Be Next?
++ +## Community Support + +Join our [Discord community](https://coollabs.io/discord) with over **19K members**, where you can create a post in the **support forum channel** for assistance. + +While the community does provide some help, the [Core team](/get-started/team) is actively involved in the forum to ensure questions are addressed. + +## Direct Support from Core Developers + +If you are a **Coolify Cloud user**, you can reach out via email at **hi@coollabs.io** for direct support from [Andras (Coolify’s founder)](https://x.com/heyandras). Since he personally handles emails, response times may be delayed. + +We highly recommend posting in the **Discord support forum** first, as core team members can escalate issues to the developers ([Andras](https://x.com/heyandras) & [Peak](https://x.com/peaklabs_dev)) if necessary. + +## Important Notes + +- We are a **small team** (fewer than **6 people**) supporting **325K+ users**, making it challenging to offer direct assistance to everyone. However, we do our best to help as much as possible. +- We are planning a **paid support option** for **self-hosted users**. If you need dedicated support for your **self-hosted instance**, email **hi@coollabs.io** to discuss options. diff --git a/content/docs/get-started/team.mdx b/content/docs/get-started/team.mdx new file mode 100644 index 00000000..0c51171b --- /dev/null +++ b/content/docs/get-started/team.mdx @@ -0,0 +1,16 @@ +--- +layout: page +title: coolLabs Team +description: Meet the international team developing Coolify including founder Andras Bacsai, core developers, community leads, and documentation maintainers. +--- + +# coolLabs Team + +Meet the international team developing Coolify including founder Andras Bacsai, core developers, community leads, and documentation maintainers. + +- **Andras Bacsai** - Founder, Lead Developer +- **Peaklabs Dev** - Core Developer +- **ShadowArcanist** - Community Lead, Docs Maintainer +- **Aditya Tripathi** - Developer, Community Moderator +- **Oren Aksakal** - Developer +- **You?** - Will You Be Next? diff --git a/content/docs/get-started/uninstallation.mdx b/content/docs/get-started/uninstallation.mdx new file mode 100644 index 00000000..4bfa6da2 --- /dev/null +++ b/content/docs/get-started/uninstallation.mdx @@ -0,0 +1,111 @@ +--- +title: Uninstalling Coolify +description: Completely remove Coolify from your self-hosted server by stopping containers, deleting volumes, networks, data directories, and Docker images. +--- + +
+ +If you're using [Coolify Cloud](https://coolify.io/pricing/), you don't need to uninstall Coolify since the Coolify Team manages everything on their servers. + +To stop using Coolify Cloud, simply visit the [Billing page](https://app.coolify.io/subscription/) and cancel your subscription. + +For those who **self-host** Coolify and wish to remove it from your server, follow the steps below to uninstall it safely: + +- [Stop and Remove Containers](#_1-stop-and-remove-containers) +- [Remove Docker Volumes](#_2-remove-docker-volumes) +- [Remove Docker Network](#_3-remove-docker-network) +- [Delete Coolify Data Directory](#_4-delete-coolify-data-directory) +- [Remove Docker Images](#_5-remove-docker-images) + +## 1. Stop and Remove Containers + +Stop all Coolify-related Docker containers and remove them to free up system resources. + +Run the following commands in your terminal: + +```bash +sudo docker stop -t 0 coolify coolify-realtime coolify-db coolify-redis coolify-proxy coolify-sentinel +sudo docker rm coolify coolify-realtime coolify-db coolify-redis coolify-proxy coolify-sentinel +``` + +The `-t 0` flag ensures that the containers stop immediately without waiting for a timeout. + +## 2. Remove Docker Volumes + +To remove the persistent data stored in Docker volumes for Coolify, run: + +```bash +sudo docker volume rm coolify-db coolify-redis +``` + + +
+ +If you're using [Coolify Cloud](https://coolify.io/pricing/), the Coolify team handles all updates so you don’t need to worry about them. + +For those who **self-host** Coolify, there are three ways to upgrade your instance: + +- [Automatic Upgrade:](#_1-automatic-upgrade) For users who want easy, hands-off updates. +- [Semi-Automatic Upgrade:](#_2-semi-automatic-upgrade) For users who want control over when to apply updates. +- [Manual Upgrade:](#_3-manual-upgrade) For advanced users who prefer to manage the upgrade process themselves. + + +
+ +So, you’ve decided to use Coolify, awesome choice! + +Now, you might be wondering whether to go with **Coolify Cloud** or set it up yourself through **self-hosting**. Let’s break it down so you can pick the best option for you. + +## Coolify Cloud + +Coolify Cloud is the easy way to get started. It’s a paid service (starting at just **$5 a month**) where you bring your own servers and connect them to a Coolify instance that’s fully managed by our team. + + +
+ +
{{team.NODE_ENV}}. 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 {{project.NODE_ENV}}. 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 {{environment.NODE_ENV}} Do not replace "environment" with your actual environment name.
+
+### Using Environment and Shared Variables in Docker Compose
+
+Within Coolify you can configure these easily following the details found in the [Knowledge Base for Docker Compose](/knowledge-base/docker/compose#shared-environment-variables).
+
+## Predefined Variables
+
+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
+```
+
+### Application Variables
+
+#### `COOLIFY_FQDN`
+
+Fully qualified domain name(s) of the application.
+
+#### `COOLIFY_URL`
+
+URL(s) of the application.
+
+#### `COOLIFY_BRANCH`
+
+Branch name of the source code.
+
+#### `COOLIFY_RESOURCE_UUID`
+
+Unique resource identifier generated by Coolify.
+
+#### `COOLIFY_CONTAINER_NAME`
+
+Name of the container generated by Coolify.
+
+#### `SOURCE_COMMIT`
+
+Commit hash of the source code.
+
+
++
+
+
+
+ You need to use the S3 HTTP endpoint without the bucket name, for example,`https://s3.eu-central-1.amazonaws.com`.
+
+
+
+
+
+## 1. Create a S3 Bucket
+To create your S3 Bucket, follow these steps:
+
+Visit https://console.aws.amazon.com/s3 and Click on **Create Bucket** button
+
+
+
+Leave everything else to default values, only change things if you know what you are doing.
+
+
+
+
+
+
+
+
+
+You won't see the policy you just created, you have to search for its name on the search box.
+
+
+
+
+
+## 3. Create a IAM User
+To create your IAM User, follow these steps:
+
+Visit https://console.aws.amazon.com/iam/home#/users and Click on **Create user** button
+
+
+ You won't able able to see the access key after you click the **Done** button, so make sure to save the keys somewhere safe.
+
+
+
+
+
+## 5. Setup S3 in Coolify
+To create your setup S3 in Coolify, follow these steps:
+
+In your Coolify dashboard:
+
+
diff --git a/content/docs/knowledge-base/s3/introduction.mdx b/content/docs/knowledge-base/s3/introduction.mdx
new file mode 100644
index 00000000..cf6a888c
--- /dev/null
+++ b/content/docs/knowledge-base/s3/introduction.mdx
@@ -0,0 +1,31 @@
+---
+title: "Introduction"
+description: "Configure S3-compatible storage for Coolify backups including AWS, DigitalOcean Spaces, MinIO, Cloudflare R2, Supabase Storage, Backblaze B2, and Scaleway Object Storage."
+---
+
+# S3 Introduction
+Currently supported S3 compatible storages are:
+
+- AWS (see [the AWS guide](/knowledge-base/s3/aws))
+- DigitalOcean Spaces
+- MinIO
+- Cloudflare's R2 (see the [R2 guide](/knowledge-base/s3/r2))
+- Supabase Storage (see the [Supabase guide](/knowledge-base/s3/supabase))
+- Backblaze B2
+- Scaleway Object Storage
+- Hetzner S3 Storage
+- Wasabi hot cloud storage
+- Vultr
+- CloudPe Object Storage
+
+Other's could work, but not tested yet. If you test it, please let us know.
+
+## S3 Client
+
+Coolify uses MinIO's client, called [`mc`](https://min.io/docs/minio/linux/reference/minio-mc.html), to copy the backup files to your S3 compatible storage.
+
+## Verification
+
+To be able to use your S3 compatible storage, you need to verify it first. Verification done with `ListObjectsV2` request to your specified bucket.
+
+So you need to create a bucket first, and then you can verify it.
diff --git a/content/docs/knowledge-base/s3/meta.json b/content/docs/knowledge-base/s3/meta.json
new file mode 100644
index 00000000..1bea2ee7
--- /dev/null
+++ b/content/docs/knowledge-base/s3/meta.json
@@ -0,0 +1,9 @@
+{
+ "title": "S3",
+ "pages": [
+ "introduction",
+ "aws",
+ "r2",
+ "supabase"
+ ]
+}
\ No newline at end of file
diff --git a/content/docs/knowledge-base/s3/r2.mdx b/content/docs/knowledge-base/s3/r2.mdx
new file mode 100644
index 00000000..1085d43b
--- /dev/null
+++ b/content/docs/knowledge-base/s3/r2.mdx
@@ -0,0 +1,21 @@
+---
+title: "Cloudflare R2"
+description: "Configure Cloudflare R2 S3-compatible storage for Coolify backups with bucket creation, API token setup, and access credentials configuration."
+---
+
+# Cloudflare R2
+Cloudflare R2 is an S3 compatible storage. You can use it with Coolify to store your backups.
+
+# Configuration
+
+1. You need to create a bucket first in the Cloudflare R2 dashboard.
+2. Then you need to create a R2 API token with `Object Read & Write` permission.
+3. You can find the S3 client credentials when the token is created.
+
+TLDR (click to view)
+ +1. Create a bucket in AWS Console +2. Create a custom policy in AWS Console with the following permissions: + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "s3:ListBucket", + "s3:GetObject", + "s3:DeleteObject", + "s3:GetObjectAcl", + "s3:PutObjectAcl", + "s3:PutObject" + ], + "Resource": [ + // rewrite your-bucket-name with your bucket name + "arn:aws:s3:::your-bucket-name", + "arn:aws:s3:::your-bucket-name/*" + ] + } + ] +} +``` + +3. Create an IAM user in AWS Console & attach the policy from the previous step. +4. Go to User settings & create an `Access Key` in AWS Console. +5. Add the `Access Key` and `Secret Key` in Coolify when you create a new S3 source. + ++
+
+
+
+ +A build server allows you to compile your projects separately from the server that hosts your live application. + +This helps to keep the load on your hosting server low and ensures that your application's performance remains unaffected by the build process. + + +## Requirements +Before you set up a build server, make sure that: + +- The final images are pushed to a container registry. +- The build server is authenticated with the container registry. See [this guide](/knowledge-base/docker/registry) for more details. +- The build server has access to your source code. +- Docker Engine is installed on the build server. +- The build server's architecture matches that of your deployment servers. + + +
+
+
+
+
+1. Can I change how frequently Coolify checks for updates?
+ +No, the update check interval is currently fixed. + +However, you can manually trigger a check by clicking the **Check now** button on the Server Patching page. + +This feature was introduced in **v4.0.0-beta.419**, and we’re focusing on improving it based on user feedback. If you'd like to request customizable check intervals, feel free to start a discussion here: [Coolify Discussions on GitHub](https://github.com/coollabsio/coolify/discussions) + +
+
+
diff --git a/content/docs/knowledge-base/server/proxies.mdx b/content/docs/knowledge-base/server/proxies.mdx
new file mode 100644
index 00000000..8099a446
--- /dev/null
+++ b/content/docs/knowledge-base/server/proxies.mdx
@@ -0,0 +1,31 @@
+---
+title: "Supported Proxy"
+description: "Learn about Traefik and Caddy reverse proxy support in Coolify for routing traffic, SSL certificates, and load balancing with switching guide"
+---
+
+# Supported Proxy
+Coolify supports `Traefik` (default) and `Caddy` (experimental) proxies.
+
+## Switch between proxies
+
+Since `beta.237`, we have added support for Caddy and Traefik as proxies. You can switch between them at any time.
+
+Before you switch proxies and if you have an application that was created before `beta.237`, you need to make sure of the following:
+
+1. You must have `caddy_*` or `traefik_*` labels on your resources.
+
+
+2. Does Coolify install updates automatically?
+ +**No**, Coolify does not install updates automatically. + +Updates are only applied when you manually click the **Update** or **Update all packages** button on the dashboard. + ++ +
+ +
+ +
+ +# What is GoatCounter? + +GoatCounter is an open source web analytics platform. It aims to offer easy to use and meaningful privacy-friendly web analytics. + +- Privacy-aware; doesn’t track users with unique identifiers and doesn't need a GDPR notice. Fine-grained control over which data is collected. + +- Lightweight and fast; adds just ~3.5K of extra data to your site. Also has JavaScript-free "tracking pixel" option, or you can use it from your application's middleware or import from logfiles. + +- Identify unique visits without cookies using a non-identifiable hash. + +- Keeps useful statistics such as browser information, location, and screen size. Keep track of referring sites and campaigns. + +- Easy; if you've been confused by the myriad of options and flexibility of Google Analytics and Matomo that you don't need then GoatCounter will be a breath of fresh air. + +- Accessibility is a high-priority feature, and the interface works well with assistive technology such as screen readers. + +## Links + +- [The official website](https://www.goatcounter.com?utm_source=coolify.io) +- [Documentation](https://www.goatcounter.com/help/start?utm_source=coolify.io) +- [GitHub](https://github.com/arp242/goatcounter?utm_source=coolify.io) diff --git a/content/docs/services/gotenberg.mdx b/content/docs/services/gotenberg.mdx new file mode 100644 index 00000000..4be19523 --- /dev/null +++ b/content/docs/services/gotenberg.mdx @@ -0,0 +1,22 @@ +--- +title: "Gotenberg" +description: "A Docker-powered stateless API for PDF files." +og: + description: "Run Gotenberg on Coolify for PDF generation from HTML, Markdown, Office files via Docker-based microservice with REST API for conversions." +category: "Development" +icon: "/docs/images/services/gotenberg-logo.png" +--- + +
+
+## What is Grimmory?
+
+Grimmory is a self-hosted ebook library manager and reader, and the successor
+to Booklore. It allows you to organize, manage, and read your ebook collection
+from a clean web interface, with support for auto-importing books via a
+bookdrop folder.
+
+## Links
+
+- [Official website](https://grimmory.org/)
+- [GitHub](https://github.com/grimmory-tools/grimmory?utm_source=coolify.io)
+- [Docker Hub](https://hub.docker.com/r/grimmory/grimmory?utm_source=coolify.io)
diff --git a/content/docs/services/grist.mdx b/content/docs/services/grist.mdx
new file mode 100644
index 00000000..e2e33c47
--- /dev/null
+++ b/content/docs/services/grist.mdx
@@ -0,0 +1,19 @@
+---
+title: "Grist"
+description: "Modern relational spreadsheet combining flexibility and database robustness."
+og:
+ description: "Run Grist spreadsheet on Coolify combining spreadsheets and databases with relational data, forms, automation, and collaborative data management."
+category: "Productivity"
+icon: "/docs/images/services/grist-logo.svg"
+---
+
++
+
+
+
+
+
+## What is Newt?
+
+Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.
+
+## Env Variables
+
+| Name | Description | Required | Default Value |
+| ----------------- | ----------- | -------- | ------------- |
+| NEWT ID | - | yes |
+| NEWT SECRET | - | yes |
+| PANGOLIN ENDPOINT | - | yes | domain.tld |
+
+## Links
+
+- [The official website](https://docs.fossorial.io/Newt/overview?utm_source=coolify.io)
+- [GitHub](https://github.com/fosrl/newt?utm_source=coolify.io)
diff --git a/content/docs/services/next-image-transformation.mdx b/content/docs/services/next-image-transformation.mdx
new file mode 100644
index 00000000..29cf0994
--- /dev/null
+++ b/content/docs/services/next-image-transformation.mdx
@@ -0,0 +1,18 @@
+---
+title: Next Image Transformation
+description: "Image transformation service for Next.js."
+og:
+ description: "Host Next.js image optimizer on Coolify for dynamic image resizing, format conversion, CDN caching, and web performance optimization."
+category: "Development"
+icon: "/docs/images/services/nextimage-logo.svg"
+---
+
+# Next Image Transformation
+
+## What is Next Image Transformation
+
+Drop-in replacement for Vercel's Nextjs image optimization service.
+
+## Links
+
+- [Official Documentation](https://github.com/coollabsio/next-image-transformation?utm_source=coolify.io)
diff --git a/content/docs/services/nextcloud.mdx b/content/docs/services/nextcloud.mdx
new file mode 100644
index 00000000..5485c8ae
--- /dev/null
+++ b/content/docs/services/nextcloud.mdx
@@ -0,0 +1,56 @@
+---
+title: "NextCloud"
+description: "A safe home for all your data."
+og:
+ description: "Deploy Nextcloud on Coolify for self-hosted cloud storage, file sync, calendar, contacts, office collaboration, and Google Drive alternative."
+category: "Storage"
+icon: "/docs/images/services/nextcloud-logo.svg"
+---
+
++
+
+## What is OpnForm?
+
+OpnForm is an open-source form builder designed to empower developers and users alike. Create beautiful forms and share them anywhere - it's super fast and you don't need to know how to code. Get started for free with unlimited forms, fields, and submissions.
+
+## Features
+
+- Drag-and-drop form builder
+- Custom themes and branding
+- Conditional logic
+- File uploads
+- Form analytics
+- Email notifications
+- Custom domains
+- No coding required
+
+## Links
+
+- [Official Website](https://opnform.com/?utm_source=coolify.io)
+- [Documentation](https://docs.opnform.com/introduction?utm_source=coolify.io)
+- [GitHub](https://github.com/opnform/opnform?utm_source=coolify.io)
diff --git a/content/docs/services/orangehrm.mdx b/content/docs/services/orangehrm.mdx
new file mode 100644
index 00000000..1e45818a
--- /dev/null
+++ b/content/docs/services/orangehrm.mdx
@@ -0,0 +1,19 @@
+---
+title: "OrangeHRM"
+description: "Free HR management system for businesses."
+og:
+ description: "Manage HR on Coolify with OrangeHRM for employee records, leave management, time tracking, recruitment, and human resource administration."
+category: "Business"
+icon: "/docs/images/services/orangehrm-logo.svg"
+---
+
+
+
+## What is Plane?
+
+Plane is a free and open-source project management tool that empowers teams to collaborate and manage projects efficiently.
+
+## Screenshots
+
++
+
+## What is Rybbit?
+
+Rybbit is a next-gen, open source, lightweight, cookieless web & product analytics for everyone.
+
+## Configuration
+
+- set frontend URL.
+- set backend URL to `$frontend_URL/api` and uncheck the "Strip Prefixes" option.
+
+# Screenshots
+
++
+
+
+
+
+
+## 7. Check Your WAF Settings
+
+If you are using a Web Application Firewall (WAF) like [Cloudflare WAF](https://www.cloudflare.com/en-gb/application-services/products/waf/?utm_source=coolify.io), make sure it is not blocking Let's Encrypt requests.
+
+## 8. Check Coolify Proxy logs
+
+On the Coolify proxy logs check for error messages.
+
+- If you see an error message with a 429 status code, it means that Let's Encrypt has rate-limited your server's IP address.
+
+ - In this case, wait for a while and check your domain again. Most users won't encounter this, but it can happen if you are using a shared IP address.
+
+- If you see an error message with a 403 status code, it means that requests from Let's Encrypt are blocked by something like a Web Application Firewall (WAF).
+
+Guide: How to Restart Proxy from Dashboard?
+ + + 1. Select your server on the Coolify Dashboard +
+
+
+
+## 9. Verify DNS Records
+
+Let's Encrypt performs a DNS lookup to resolve the IP address of your server. If you have both **IPv4 (A record)** and **IPv6 (AAAA record)** configured to point to your server, Let's Encrypt will verify both records during the domain ownership challenge.
+
+- **If both IPv4 and IPv6 are present**, Let's Encrypt may prefer to use **IPv6** for the challenge, but **both IPv4 and IPv6 should be able to complete the challenge**.
+
+### Why This Matters:
+
+If either the **IPv4** or **IPv6** address is misconfigured, the challenge may fail. For example:
+
+- If your domain resolves to both **IPv4** and **IPv6**, but the **IPv6 (AAAA) record** has **port 80 closed**, the HTTP challenge will fail. Similarly, if **port 443** is closed for IPv6, the TLS-ALPN challenge will fail, even if **IPv4** passes the challenge.
+
+To ensure successful validation:
+
+- Both **IPv4 (A record)** and **IPv6 (AAAA record)** must be able to serve the challenge file correctly.
+
+If you don’t need IPv6, you can remove the **AAAA record** from your DNS configuration. This will make Let's Encrypt use **IPv4** for the challenge.
+
+## Support
+
+If none of the above steps work, try these additional options:
+
+- **Community Help:** Join our [Discord community](https://coolify.io/discord) and post in the support forum channel.
+- **What to Share:** Include a description of your issue, any error messages, and the steps you have already tried.
diff --git a/content/docs/troubleshoot/dns-and-domains/meta.json b/content/docs/troubleshoot/dns-and-domains/meta.json
new file mode 100644
index 00000000..d8ff176d
--- /dev/null
+++ b/content/docs/troubleshoot/dns-and-domains/meta.json
@@ -0,0 +1,8 @@
+{
+ "title": "DNS & Domains",
+ "pages": [
+ "wildcard-ssl-certs",
+ "lets-encrypt-not-working",
+ "certificate-resolver-doesnt-exist"
+ ]
+}
\ No newline at end of file
diff --git a/content/docs/troubleshoot/dns-and-domains/wildcard-ssl-certs.mdx b/content/docs/troubleshoot/dns-and-domains/wildcard-ssl-certs.mdx
new file mode 100644
index 00000000..46c56937
--- /dev/null
+++ b/content/docs/troubleshoot/dns-and-domains/wildcard-ssl-certs.mdx
@@ -0,0 +1,48 @@
+---
+title: Coolify not using Wildcard SSL Certificates
+description: Fix wildcard SSL certificate issues in Coolify by verifying installation, checking proxy configuration, and clearing browser cache.
+---
+
+# Coolify not using Wildcard SSL Certificates
+
+If your wildcard SSL certificate isn't working with your domain, it may be due to configuration problems. Here's how you can check and fix it.
+
+## 1. Check the SSL Certificate Validity
+
+- **Verify the Certificate:** Make sure the SSL certificate is valid for the domain.
+ - Confirm the Common Name (CN) matches your domain.
+ - Double-check that your wildcard certificate is not expired.
+
+## 2. Verify Certificate Installation
+
+- **File Extensions:** Make sure the SSL certificate file ends with `.cert` and the key file ends with `.key`.
+ - Some providers give files in `.pem` format, which must be converted to `.cert` and `.key` before adding them to your server (simply rename the files to `.cert` for the certificate and `.key` for the key)
+- **File Location:** Make sure your `.cert` and `.key` files are located in the `/data/coolify/proxy/certs` directory.
+
+## 3. Check the Coolify Proxy Configuration
+
+- **Add Certificate in Dashboard:** Make sure you have added the SSL certificate configuration in the Coolify proxy via the dashboard. More details can be found [here](/knowledge-base/proxy/traefik/custom-ssl-certs).
+- **Check File Mounts:** If you have modified the proxy configuration, verify that the `/data/coolify/proxy` directory is mounted correctly.
+
+## 4. Remove Old Certificates
+
+- **Old Certificate Issue:** The Coolify proxy may be using an old certificate stored in the `acme.json` file.
+- **Action:** Delete the `acme.json` file from the `/data/coolify/proxy` directory and restart the Coolify proxy from the dashboard by clicking the restart proxy button.
+
+## 5. Clear Your Browser Cache
+
+- **Cache Issue:** Your browser might be caching an old SSL certificate.
+- **Action:** Check your website using a different browser or network.
+ - You can also use sandbox tools like [Browserling](https://www.browserling.com?utm_source=coolify.io) to test your site.
+
+## 6. Verify DNS Challenge Configuration
+
+- **DNS Challenge Check:** If you are using a DNS challenge, confirm that it is set up correctly.
+- **Action:** Verify that you have selected the correct DNS provider, API Keys and check the challenge settings are properly configured.
+
+## Support
+
+If none of the above steps work, try these additional options:
+
+- **Community Help:** Join our [Discord community](https://coolify.io/discord) and post in the support forum channel.
+- **What to Share:** Include a description of your issue, screenshots of your configuration, any error messages, and the steps you have already tried.
diff --git a/content/docs/troubleshoot/docker/expired-github-personal-access-token.mdx b/content/docs/troubleshoot/docker/expired-github-personal-access-token.mdx
new file mode 100644
index 00000000..809357a6
--- /dev/null
+++ b/content/docs/troubleshoot/docker/expired-github-personal-access-token.mdx
@@ -0,0 +1,27 @@
+---
+title: "Expired GitHub Personal Access Token (PAT)"
+description: "Fix GitHub Container Registry authentication errors by logging out of ghcr.io or renewing expired GitHub Personal Access Tokens for Docker deployments."
+---
+# Expired GitHub Personal Access Token (PAT)
+
+If you encounter the following errors, it means Docker cannot authenticate with the GitHub Container Registry (ghcr.io):
+
+## Error
+
+```bash
+ Error response from daemon: Head "https://ghcr.io/v2/coollabsio/coolify-helper/manifests/1.0.1": unauthorized: authentication required
+```
+> or
+
+```bash
+ Unable to find image 'ghcr.io/coollabsio/coolify-helper:latest' locally
+ docker: Error response from daemon: Head "https://ghcr.io/v2/coollabsio/coolify-helper/manifests/latest": denied: denied
+```
+
+## Solution
+You have two options:
+- Log out of GitHub Container Registry (ghcr.io) by running:
+ ```bash
+ docker logout ghcr.io
+ ```
+- Renew your GitHub Personal Access Token (PAT) if you need to maintain authenticated access for deployments.
diff --git a/content/docs/troubleshoot/docker/meta.json b/content/docs/troubleshoot/docker/meta.json
new file mode 100644
index 00000000..b3ed59d5
--- /dev/null
+++ b/content/docs/troubleshoot/docker/meta.json
@@ -0,0 +1,6 @@
+{
+ "title": "Docker",
+ "pages": [
+ "expired-github-personal-access-token"
+ ]
+}
\ No newline at end of file
diff --git a/content/docs/troubleshoot/index.mdx b/content/docs/troubleshoot/index.mdx
new file mode 100644
index 00000000..a0ffe318
--- /dev/null
+++ b/content/docs/troubleshoot/index.mdx
@@ -0,0 +1,20 @@
+---
+title: Troubleshooting Overview
+description: Comprehensive Coolify troubleshooting guides covering deployment errors, server issues, proxy problems, SSL certificates, and application configuration fixes.
+---
+
+# 🔧 Troubleshooting
+
+This section provides solutions for resolving issues you might encounter with Coolify.
+
+Check the sidebar for a list of all available trouble shooting guides.
+
+
+Guide: How to check Coolify proxy logs?
+ + + 1. Select your server on the Coolify Dashboard +-
-
## What is Newt?
diff --git a/docs/services/ollama.md b/docs/services/ollama.md
index 9e3eaf52..24ed8bed 100644
--- a/docs/services/ollama.md
+++ b/docs/services/ollama.md
@@ -7,7 +7,7 @@ category: "AI"
icon: "/docs/images/services/ollama-logo.svg"
---
-
## What is OpnForm?
diff --git a/docs/services/plane.md b/docs/services/plane.md
index e1d32303..1077159f 100644
--- a/docs/services/plane.md
+++ b/docs/services/plane.md
@@ -7,7 +7,7 @@ category: "Project Management"
icon: "/docs/images/services/plane-logo.svg"
---
-
+
## What is Plane?
diff --git a/docs/services/prowlarr.md b/docs/services/prowlarr.md
index 9af6d7c0..1c7eb4be 100644
--- a/docs/services/prowlarr.md
+++ b/docs/services/prowlarr.md
@@ -7,7 +7,7 @@ category: "Media"
icon: "/docs/images/services/prowlarr-logo.svg"
---
-
## What is Rybbit?
diff --git a/docs/services/wireguard-easy.md b/docs/services/wireguard-easy.md
index 6a912652..b33bcb9b 100644
--- a/docs/services/wireguard-easy.md
+++ b/docs/services/wireguard-easy.md
@@ -9,7 +9,7 @@ icon: "/docs/images/services/wireguardeasy-logo.svg"
# Wireguard Easy
-${title ? `\n\n`
+}
+
+function convertContainers(text) {
+ const stack = []
+ const lines = text.split('\n')
+
+ const converted = lines
+ .map((line) => {
+ if (/^:{3,4}\s*$/.test(line.trim())) {
+ if (stack.length === 0) return ''
+ const kind = stack.pop()
+ return kind === 'details' ? '\n
\n' : '\n\n'
+ }
+
+ const containerLine = line.trim().replace(/^[-*]\s+/, '')
+ if (/^:{3,4}\s*[a-zA-Z-]+/.test(containerLine)) {
+ const kind = containerLine.match(/^:{3,4}\s*([a-zA-Z-]+)/)?.[1]?.toLowerCase()
+ stack.push(kind === 'details' ? 'details' : 'callout')
+ return convertContainerOpen(containerLine)
+ }
+
+ return line
+ })
+
+ while (stack.length > 0) {
+ const kind = stack.pop()
+ converted.push(kind === 'details' ? '\n\n' : '\n\n')
+ }
+
+ return converted.join('\n')
+}
+
+function convertVueTeamPage(markdown) {
+ if (!markdown.includes('