Skip to content

Latest commit

 

History

History
207 lines (150 loc) · 8.65 KB

CONTRIBUTING.md

File metadata and controls

207 lines (150 loc) · 8.65 KB
Raw

Contributing to Coolify

"First, thanks for considering contributing to my project. It really means a lot!" - @andrasbacsai

You can ask for guidance anytime on our Discord server in the #contribute channel.

Table of Contents

  1. Setup Development Environment
  2. Verify Installation
  3. Fork and Setup Local Repository
  4. Set up Environment Variables
  5. Start Coolify
  6. Start Development
  7. Development Notes
  8. Create a Pull Request
  9. 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
      • After installing WSL2, install Docker CE for your Linux distribution by following this guide: Install Docker Engine
      • Make sure to choose the appropriate Linux distribution (e.g., Ubuntu) when following the Docker installation guide
    • Install Docker Desktop (easier):

  2. Install Spin:

MacOS

  1. Install Orbstack, Docker Desktop (or similar):

    • Orbstack (recommended, as it is a faster and lighter alternative to Docker Desktop):
    • Docker Desktop:

  2. Install Spin:

Linux

  1. Install Docker Engine, Docker Desktop (or similar):

  2. Install Spin:

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: 
    docker --version
spin --version
    You should see version information for both Docker and Spin.

3. Fork and Setup Local Repository

  1. Fork the 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
    Cursor (recommended but paid) Windows/macOS/Linux Download
    Zed (very fast) macOS/Linux Download

  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/
      • 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): 
    spin up

Note

You may see some errors, but don't worry; this is expected.

  1. If you encounter permission errors, especially on macOS, use: 
    sudo spin up

Note

If you change environment variables afterwards or anything seems broken, press Ctrl + C to stop the process and run spin up again.

6. Start Development

  1. Access your Coolify instance:

  2. Additional development tools:

    Tool URL Note
    Laravel Horizon (scheduler) http://localhost:8000/horizon Only accessible when logged in as root user
    Mailpit (email catcher) http://localhost:8025
    Telescope (debugging tool) http://localhost:8000/telescope Disabled by default

Note

To enable Telescope, add the following to your .env file:

TELESCOPE_ENABLED=true

7. Development Notes

When working on Coolify, keep the following in mind:

  1. Database Migrations: After switching branches or making changes to the database structure, always run migrations:

    docker exec -it coolify php artisan migrate

  2. Resetting Development Setup: To reset your development setup to a clean database with default values:

    docker exec -it coolify php artisan migrate:fresh --seed

  3. Troubleshooting: If you encounter unexpected behavior, ensure your database is up-to-date with the latest migrations and if possible reset the development setup to eliminate any environment-specific issues.

Important

Forgetting to migrate the database can cause problems, so make it a habit to run migrations after pulling changes or switching branches.

8. Create a Pull Request

  1. After making changes or adding a new service:

    • Commit your changes to your forked repository.
    • Push the changes to your GitHub account.

  2. Creating the Pull Request (PR):

    • Navigate to the main Coolify repository on GitHub.
    • Click the "Pull requests" tab.
    • Click the green "New pull request" button.
    • Choose your fork and branch as the compare branch.
    • Click "Create pull request".

  3. Filling out the PR details:

    • Give your PR a descriptive title.
    • In the description, explain the changes you've made.
    • Reference any related issues by using keywords like "Fixes #123" or "Closes #456".

Important

Always set the base branch for your PR to the next branch of the Coolify repository, not the main branch.

  1. Submit your PR:
    • Review your changes one last time.
    • Click "Create pull request" to submit.

Note

Make sure your PR is out of draft mode as soon as it's ready for review. PRs that are in draft mode for a long time may be closed by maintainers.

After submission, maintainers will review your PR and may request changes or provide feedback.

Additional Contribution Guidelines

Contributing a New Service

To add a new service to Coolify, please refer to our documentation: Adding a New Service

Contributing to Documentation

To contribute to the Coolify documentation, please refer to this guide: Contributing to the Coolify Documentation