You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Install Windows Subsystem for Linux v2 (WSL2) by following this guide: [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
33
-
- After installing WSL2, install Docker CE for your Linux distribution by following this guide: [Install Docker Engine](https://docs.docker.com/engine/install/)
33
+
- Install Windows Subsystem for Linux v2 (WSL2) by following this guide: [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install?ref=coolify)
34
+
- 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)
34
35
- Make sure to choose the appropriate Linux distribution (e.g., Ubuntu) when following the Docker installation guide
35
36
- Install Docker Desktop (easier):
36
-
- Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/)
37
+
- Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/?ref=coolify)
37
38
- Ensure WSL2 backend is enabled in Docker Desktop settings
38
39
39
40
2. Install Spin:
40
-
- 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)
41
+
- 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)
41
42
42
43
</details>
43
44
@@ -46,12 +47,12 @@ Follow the steps below for your operating system:
46
47
47
48
1. Install Orbstack, Docker Desktop (or similar):
48
49
- Orbstack (recommended, as it is a faster and lighter alternative to Docker Desktop):
49
-
- Download and install [Orbstack](https://docs.orbstack.dev/quick-start#installation)
50
+
- Download and install [Orbstack](https://docs.orbstack.dev/quick-start#installation?ref=coolify)
50
51
- Docker Desktop:
51
-
- Download and install [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/)
52
+
- Download and install [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/?ref=coolify)
52
53
53
54
2. Install Spin:
54
-
- 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)
55
+
- 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)
55
56
56
57
</details>
57
58
@@ -60,12 +61,12 @@ Follow the steps below for your operating system:
- Docker Engine (recommended, as there is no VM overhead):
63
-
- Follow the official [Docker Engine installation guide](https://docs.docker.com/engine/install/) for your Linux distribution
64
+
- Follow the official [Docker Engine installation guide](https://docs.docker.com/engine/install/?ref=coolify) for your Linux distribution
64
65
- Docker Desktop:
65
-
- If you want a GUI, you can use [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/)
66
+
- If you want a GUI, you can use [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/?ref=coolify)
66
67
67
68
2. Install Spin:
68
-
- 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)
69
+
- 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)
69
70
70
71
</details>
71
72
@@ -89,14 +90,14 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
89
90
90
91
| Editor | Platform | Download Link |
91
92
|--------|----------|---------------|
92
-
| Visual Studio Code (recommended free) | Windows/macOS/Linux |[Download](https://code.visualstudio.com/download)|
93
-
| Cursor (recommended but paid) | Windows/macOS/Linux |[Download](https://www.cursor.com/)|
3. Clone the Coolify Repository from your fork to your local machine
97
98
- Use `git clone` in the command line, or
98
99
- Use GitHub Desktop (recommended):
99
-
- Download and install from [https://desktop.github.com/](https://desktop.github.com/)
100
+
- Download and install from [https://desktop.github.com/](https://desktop.github.com/?ref=coolify)
100
101
- Open GitHub Desktop and login with your GitHub account
101
102
- 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`
102
103
@@ -149,26 +150,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
149
150
> TELESCOPE_ENABLED=true
150
151
> ```
151
152
152
-
## 7. Development Notes
153
-
154
-
When working on Coolify, keep the following in mind:
155
-
156
-
1. **Database Migrations**: After switching branches or making changes to the database structure, always run migrations:
157
-
```bash
158
-
docker exec -it coolify php artisan migrate
159
-
```
160
-
161
-
2.**Resetting Development Setup**: To reset your development setup to a clean database with default values:
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.
167
-
168
-
> [!IMPORTANT]
169
-
> Forgetting to migrate the database can cause problems, so make it a habit to run migrations after pulling changes or switching branches.
170
-
171
-
## 8. Create a Pull Request
153
+
## 7. Create a Pull Request
172
154
173
155
1. After making changes or adding a new service:
174
156
- Commit your changes to your forked repository.
@@ -183,8 +165,7 @@ When working on Coolify, keep the following in mind:
183
165
184
166
3. Filling out the PR details:
185
167
- Give your PR a descriptive title.
186
-
- In the description, explain the changes you've made.
187
-
- Reference any related issues by using keywords like "Fixes #123" or "Closes #456".
168
+
- Use the Pull Request Template provided and fill in the details.
188
169
189
170
> [!IMPORTANT]
190
171
> Always set the base branch for your PR to the `next` branch of the Coolify repository, not the `main` branch.
@@ -198,6 +179,61 @@ When working on Coolify, keep the following in mind:
198
179
199
180
After submission, maintainers will review your PR and may request changes or provide feedback.
200
181
182
+
## Development Notes
183
+
184
+
When working on Coolify, keep the following in mind:
185
+
186
+
1. **Database Migrations**: After switching branches or making changes to the database structure, always run migrations:
187
+
```bash
188
+
docker exec -it coolify php artisan migrate
189
+
```
190
+
191
+
2.**Resetting Development Setup**: To reset your development setup to a clean database with default values:
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.
197
+
198
+
> [!IMPORTANT]
199
+
> Forgetting to migrate the database can cause problems, so make it a habit to run migrations after pulling changes or switching branches.
200
+
201
+
## Resetting Development Environment
202
+
203
+
If you encounter issues or break your database or something else, follow these steps to start from a clean slate (works since `v4.0.0-beta.342`):
After completing these steps, you'll have a fresh development setup.
233
+
234
+
> [!IMPORTANT]
235
+
> Always run database migrations and seeders after switching branches or pulling updates to ensure your local database structure matches the current codebase and includes necessary seed data.
0 commit comments