Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions apps/ideploy/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This file provides guidance to **Claude Code** (claude.ai/code) when working wit

## Project Overview

Coolify is an open-source, self-hostable platform for deploying applications and managing servers - an alternative to Heroku/Netlify/Vercel. It's built with Laravel (PHP) and uses Docker for containerization.
iDeploy is an open-source, self-hostable platform for deploying applications and managing servers - an alternative to Heroku/Netlify/Vercel. It's built with Laravel (PHP) and uses Docker for containerization.

## Development Commands

Expand Down Expand Up @@ -58,7 +58,7 @@ Only run artisan commands inside "ideploy" container when in development.
#### Core Models

- `Application` - Deployed applications with Git integration (74KB, highly complex)
- `Server` - Remote servers managed by Coolify (46KB, complex)
- `Server` - Remote servers managed by iDeploy (46KB, complex)
- `Service` - Docker Compose services (58KB, complex)
- `Database` - Standalone database instances (PostgreSQL, MySQL, MongoDB, Redis, etc.)
- `Team` - Multi-tenancy support
Expand Down Expand Up @@ -103,7 +103,7 @@ Only run artisan commands inside "ideploy" container when in development.

### Frontend Philosophy

Coolify uses a **server-side first** approach with minimal JavaScript:
iDeploy uses a **server-side first** approach with minimal JavaScript:

- **Livewire** for server-side rendering with reactive components
- **Alpine.js** for lightweight client-side interactions
Expand Down Expand Up @@ -271,7 +271,7 @@ class MyComponent extends Component

## Cloud Instance Considerations

We have a cloud instance of Coolify (hosted version) with:
We have a cloud instance of iDeploy (hosted version) with:

- 2 Horizon worker servers
- Thousands of connected servers
Expand Down
38 changes: 19 additions & 19 deletions apps/ideploy/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Coolify
# Contributing to iDeploy

> "First, thanks for considering contributing to my project. It really means a lot!" - [@andrasbacsai](https://github.com/andrasbacsai)

Expand All @@ -12,7 +12,7 @@ To understand the tech stack, please refer to the [Tech Stack](TECH_STACK.md) do
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-ideploy)
5. [Start iDeploy](#5-start-ideploy)
6. [Start Development](#6-start-development)
7. [Create a Pull Request](#7-create-a-pull-request)
8. [Development Notes](#development-notes)
Expand Down Expand Up @@ -82,7 +82,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:

## 3. Fork and Setup Local Repository

1. Fork the [Coolify](https://github.com/coollabsio/ideploy) repository to your GitHub account.
1. Fork the [iDeploy](https://github.com/coollabsio/ideploy) repository to your GitHub account.

2. Install a code editor on your machine (choose one):

Expand All @@ -92,26 +92,26 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
| Cursor (recommended but paid) | Windows/macOS/Linux | [Download](https://www.cursor.com/?ref=ideploy) |
| Zed (very fast) | macOS/Linux | [Download](https://zed.dev/download?ref=ideploy) |

3. Clone the Coolify Repository from your fork to your local machine
3. Clone the iDeploy 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=ideploy)
- 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`
- Click on `File` -> `Clone Repository` select `github.com` as the repository location, then select your forked iDeploy repository, choose the local path and then click `Clone`

4. Open the cloned Coolify Repository in your chosen code editor.
4. Open the cloned iDeploy 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.
1. In the Code Editor, locate the `.env.development.example` file in the root directory of your local iDeploy 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
## 5. Start iDeploy

1. Open a terminal in the local Coolify directory.
1. Open a terminal in the local iDeploy directory.
2. Run the following command in the terminal (leave that terminal open):
```bash
spin up
Expand All @@ -130,7 +130,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:

## 6. Start Development

1. Access your Coolify instance:
1. Access your iDeploy instance:
- URL: `http://localhost:8000`
- Login: `test@example.com`
- Password: `password`
Expand All @@ -157,7 +157,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
- Push the changes to your GitHub account.

2. Creating the Pull Request (PR):
- Navigate to the main Coolify repository on GitHub.
- Navigate to the main iDeploy repository on GitHub.
- Click the "Pull requests" tab.
- Click the green "New pull request" button.
- Choose your fork and branch as the compare branch.
Expand All @@ -168,7 +168,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
- Use the Pull Request Template provided and fill in the details.

> [!IMPORTANT]
> Always set the base branch for your PR to the `next` branch of the Coolify repository, not the `main` branch.
> Always set the base branch for your PR to the `next` branch of the iDeploy repository, not the `main` branch.

4. Submit your PR:
- Review your changes one last time.
Expand All @@ -181,7 +181,7 @@ After submission, maintainers will review your PR and may request changes or pro

## Development Notes

When working on Coolify, keep the following in mind:
When working on iDeploy, keep the following in mind:

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

Expand All @@ -206,13 +206,13 @@ If you encounter issues or break your database or something else, follow these s

1. Stop all running containers `ctrl + c`.

2. Remove all Coolify containers:
2. Remove all iDeploy containers:

```bash
docker rm ideploy ideploy-db ideploy-redis ideploy-realtime ideploy-testing-host ideploy-minio ideploy-vite-1 ideploy-mail
```

3. Remove Coolify volumes (it is possible that the volumes have no `ideploy` prefix on your machine, in that case remove the prefix from the command):
3. Remove iDeploy volumes (it is possible that the volumes have no `ideploy` prefix on your machine, in that case remove the prefix from the command):

```bash
docker volume rm ideploy_dev_backups_data ideploy_dev_postgres_data ideploy_dev_redis_data ideploy_dev_ideploy_data ideploy_dev_minio_data
Expand All @@ -224,7 +224,7 @@ If you encounter issues or break your database or something else, follow these s
docker image prune -a
```

5. Start Coolify again:
5. Start iDeploy again:

```bash
spin up
Expand All @@ -244,10 +244,10 @@ After completing these steps, you'll have a fresh development setup.

### Contributing a New Service

To add a new service to Coolify, please refer to our documentation:
To add a new service to iDeploy, please refer to our documentation:
[Adding a New Service](https://ideploy.io/docs/get-started/contribute/service)

### Contributing to Documentation

To contribute to the Coolify documentation, please refer to this guide:
[Contributing to the Coolify Documentation](https://github.com/coollabsio/documentation-ideploy/blob/main/readme.md)
To contribute to the iDeploy documentation, please refer to this guide:
[Contributing to the iDeploy Documentation](https://github.com/coollabsio/documentation-ideploy/blob/main/readme.md)
8 changes: 4 additions & 4 deletions apps/ideploy/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Coolify Release Guide
# iDeploy Release Guide

This guide outlines the release process for Coolify, intended for developers and those interested in understanding how Coolify releases are managed and deployed.
This guide outlines the release process for iDeploy, intended for developers and those interested in understanding how iDeploy releases are managed and deployed.

## Table of Contents

Expand Down Expand Up @@ -116,7 +116,7 @@ When a new version is released and a new GitHub release is created, it doesn't i
- Updates are managed by Andras, who ensures each cloud version is thoroughly tested and stable before releasing it.

> [!IMPORTANT]
> The cloud version of Coolify may be several versions behind the latest GitHub releases even if the CDN is updated. This is intentional to ensure stability and reliability for cloud users and Andras will manully update the cloud version when the update is ready.
> The cloud version of iDeploy may be several versions behind the latest GitHub releases even if the CDN is updated. This is intentional to ensure stability and reliability for cloud users and Andras will manully update the cloud version when the update is ready.

## Manually Update/ Downgrade to Specific Versions

Expand All @@ -126,7 +126,7 @@ When a new version is released and a new GitHub release is created, it doesn't i
> [!IMPORTANT]
> Downgrading is supported but not recommended and can cause issues because of database migrations and other changes.

To update your Coolify instance to a specific version, use the following command:
To update your iDeploy instance to a specific version, use the following command:

```bash
curl -fsSL https://cdn.coollabs.io/ideploy/install.sh | bash -s <version>
Expand Down
2 changes: 1 addition & 1 deletion apps/ideploy/TECH_STACK.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Coolify Technology Stack
# iDeploy Technology Stack

## Frontend

Expand Down
Loading