DOCSEARCHbyAlgolia
Submit Docs

Coolify Documentation

website·Indexed 35 days ago

https://docs.coollabs.io

Documentation for Coolify v3, an open-source self-hosting platform. Includes guides on installation, architecture, and deploying applications using Docker, Docker Compose, and various frameworks such as Next.js, Node.js, Python, Rust, and Laravel.

Tokens
8.1K
Snippets
18
Records
84
Agent score
64%

What's inside Coolify

  1. Overview of safeTyper

    safeTyper is a privacy-focused alternative to Grammarly. It allows users to maintain ownership of their typed data. The MVP version (1.0) utilizes OpenAI's GPT models via API to perform grammar checks. Because it uses the OpenAI API, data is handled according to OpenAI's API privacy policies (which generally do not use API data to train models).

  2. Overview of Coolify self-hosting platform

    v3

    Coolify is a self-hostable, all-in-one IaaS (Infrastructure as a Service) solution designed as an alternative to platforms like Heroku and Netlify. It allows users to host applications, databases, and open-source services with minimal configuration. Key capabilities include:

    • Application Deployment: Supports Static, NodeJS, Svelte, React, Vue, Next, Nuxt, Astro, PHP, and Rust with automatic reverse proxy and free SSL certificates.
    • Database Management: One-click deployment for MongoDB, MySQL, PostgreSQL, CouchDB, and RedisDB.
    • Service Deployment: One-click deployment for tools such as WordPress, Ghost, Plausible Analytics, NocoDB, BitWarden/VaultWarden, LanguageTool, N8n, and VSCode Server.
    • Infrastructure Flexibility: Resources can be deployed to either a Local Docker Engine or a Remote Docker Engine.
    • Git Integration: Integrates with GitHub and GitLab (both hosted and self-hosted versions), supporting automatic deployments for new commits and separate deployments for pull requests.
    • Team Management: Includes a team management system where teams are separated by namespaces.

  3. Overview of Coolify Services

    v3
    Services in Coolify are popular open-source, self-hostable applications provided as pre-configured templates. Supported services include WordPress, Ghost, Plausible Analytics, NocoDB, VSCode Server, MinIO, VaultWarden, LanguageTool, n8n, Uptime Kuma, MeiliSearch, Umami, Fider, Hasura, Appwrite, and Glitchtip. Note that some applications may take several minutes to fully start up after initiation.

  4. Overview of coolLabs open-source projects

    coolLabs provides a suite of open-source, self-hostable, and privacy-focused applications. Current projects include:

    • Coolify (coolify.io): An open-source alternative to Heroku, Netlify, and Vercel.
    • SafeTyper (safetyper.com): A privacy-centric alternative to Grammarly.
    • Fonts (fonts.coollabs.io): A privacy-friendly drop-in replacement for Google Fonts.
    • Images (images.coollabs.io): An open-source, self-hostable image optimization service that serves as a drop-in replacement for Vercel's Image Optimization.

  7. Configure Git Sources in Coolify

    v3
    Git Sources in Coolify define where application code is fetched from. They are used to set up helper apps (GitHub/GitLab Apps), manage access via tokens or SSH keys, clone application code, and configure webhooks for automated deployments. Coolify supports GitHub and GitLab, including their self-hosted and enterprise versions.

  8. Deploy PHP applications with Coolify

    v3

    Coolify uses a PHP build pack that includes most necessary modules. It automatically determines the web server and dependency management based on the repository content:

    • Web Server Selection: By default, Nginx is used. However, if a .htaccess file is detected in the root directory, Coolify switches to Apache to support custom rules.
    • Dependency Management: If a composer.json file is detected, Composer will automatically install all required dependencies.
    • Base Images: The deployment utilizes webdevops/php-nginx or webdevops/php-apache as the base Docker images.

  9. Understand Destinations in Coolify

    v3
    Destinations in Coolify define the target environment where applications, databases, or services are deployed. Using destinations allows for network separation; resources deployed within the same destination/network can communicate with each other.

  10. Understand Coolify system architecture

    v3

    Coolify is composed of several core components that manage the deployment and routing of resources:

    • User Interface: A static SPA built with SvelteKit used for configuration and monitoring.
    • API: A Fastify-based backend service that manages communication with remote resources, databases, and Docker Engines.
    • HTTP Proxy: A dynamically configured Traefik instance that handles reverse proxy configurations, SSL certificate generation, and routing incoming HTTP traffic to containers.
    • TCP Proxies: Separate Traefik instances used specifically for databases to proxy TCP connections from the internet.
    • SSL Management: Integrated Let's Encrypt support for automated certificate generation.

  11. Deploy Gatsby applications using Coolify's predefined configuration

    v3
    Coolify provides a specialized Gatsby deployment option that uses the webdevops/nginx:alpine base Docker image. Unlike the generic static build pack, this predefined configuration automatically handles the necessary install commands, build commands, and publish directory settings, removing the need for manual configuration of these parameters.

  12. Deploy applications using Docker Compose build packs in Coolify

    v3
    Coolify provides a Docker Compose build pack that allows users to build and serve applications using docker-compose.yaml files. This is particularly useful for deploying services or applications that are not natively supported by other Coolify build packs, provided a valid Docker Compose configuration exists.