commit
8994dde8f0
@ -1,57 +1,48 @@
|
|||||||
# Contribution
|
# Contributing
|
||||||
|
|
||||||
First, thanks for considering to contribute to my project. It really means a lot! :)
|
> "First, thanks for considering to contribute to my project.
|
||||||
|
It really means a lot! 😁" - [@andrasbacsai](https://github.com/andrasbacsai)
|
||||||
|
|
||||||
You can ask for guidance anytime on our Discord server in the #contribution channel.
|
You can ask for guidance anytime on our
|
||||||
|
[Discord server](https://coollabs.io/discord) in the `#contribution` channel.
|
||||||
|
|
||||||
## Setup your development environment
|
You'll need a set of skills to [get started](docs/contribution/GettingStarted.md).
|
||||||
### Container based development flow (recommended and the easiest)
|
|
||||||
All you need is to intall [Docker Engine 20.11+](https://docs.docker.com/engine/install/) on your local machine and run `pnpm dev:container`. It will build the base image for Coolify and start the development server inside Docker. All required ports (3000, 3001) will be exposed to your host.
|
|
||||||
|
|
||||||
### Github codespaces
|
## 1) Setup your development environment
|
||||||
|
|
||||||
If you have github codespaces enabled then you can just create a codespace and run `pnpm dev` to run your the dev environment. All the required dependencies and packages has been configured for you already.
|
- 🌟 [Container based](docs/dev_setup/Container.md) ← *Recomended*
|
||||||
|
- 📦 [DockerContainer](docs/dev_setup/DockerContiner.md) *WIP
|
||||||
|
- 🐙 [Github Codespaces](docs/dev_setup/GithubCodespaces.md)
|
||||||
|
- ☁️ [GitPod](docs/dev_setup/GitPod.md)
|
||||||
|
- 🍏 [Local Mac](docs/dev_setup/Mac.md)
|
||||||
|
|
||||||
### Gitpod
|
## 2) Basic requirements
|
||||||
1. Use [container based development flow](#container-based-development-flow-easiest)
|
|
||||||
2. Or setup your workspace manually:
|
|
||||||
|
|
||||||
Create a workspace from this repository, run `pnpm install && pnpm db:push && pnpm db:seed` and then `pnpm dev`. All the required dependencies and packages has been configured for you already.
|
- [Install Pnpm](https://pnpm.io/installation)
|
||||||
|
- [Install Docker Engine](https://docs.docker.com/engine/install/)
|
||||||
|
- [Setup Docker Compose Plugin](https://docs.docker.com/compose/install/compose-plugin/)
|
||||||
|
- [Setup GIT LFS Support](https://git-lfs.github.com/)
|
||||||
|
|
||||||
> Some packages, just `pack` are not installed in this way. You cannot test all the features. Please use the [container based development flow](#container-based-development-flow-easiest).
|
## 3) Setup Coolify
|
||||||
|
|
||||||
### Local Machine
|
- Copy `apps/api/.env.example` to `apps/api/.env`
|
||||||
> At the moment, Coolify `doesn't support Windows`. You must use `Linux` or `MacOS` or consider using Gitpod or Github Codespaces.
|
- Edit `apps/api/.env`, set the `COOLIFY_APP_ID` environment variable to something cool.
|
||||||
|
- Run `pnpm install` to install dependencies.
|
||||||
|
- Run `pnpm db:push` to o create a local SQlite database. This will apply all migrations at `db/dev.db`.
|
||||||
|
- Run `pnpm db:seed` seed the database.
|
||||||
|
- Run `pnpm dev` start coding.
|
||||||
|
|
||||||
Install all the prerequisites manually to your host system. If you would not like to install anything, I suggest to use the [container based development flow](#container-based-development-flow-easiest).
|
```sh
|
||||||
|
# Or... Copy and paste commands bellow:
|
||||||
|
cp apps/api/.env.example apps/api.env
|
||||||
|
pnpm install
|
||||||
|
pnpm db:push
|
||||||
|
pnpm db:seed
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
- Due to the lock file, this repository is best with [pnpm](https://pnpm.io). I recommend you try and use `pnpm` because it is cool and efficient!
|
## 4) Start Coding
|
||||||
- You need to have [Docker Engine](https://docs.docker.com/engine/install/) installed locally.
|
|
||||||
- You need to have [Docker Compose Plugin](https://docs.docker.com/compose/install/compose-plugin/) installed locally.
|
|
||||||
- You need to have [GIT LFS Support](https://git-lfs.github.com/) installed locally.
|
|
||||||
|
|
||||||
Optional:
|
You should be able to access `http://localhost:3000`.
|
||||||
- To test Heroku buildpacks, you need [pack](https://github.com/buildpacks/pack) binary installed locally.
|
|
||||||
|
|
||||||
### Inside a Docker container
|
1. Click `Register` and setup your first user.
|
||||||
`WIP`
|
|
||||||
|
|
||||||
## Setup Coolify
|
|
||||||
- Copy `apps/api/.env.template` to `apps/api/.env.template` and set the `COOLIFY_APP_ID` environment variable to something cool.
|
|
||||||
- `pnpm install` to install dependencies.
|
|
||||||
- `pnpm db:push` to o create a local SQlite database.
|
|
||||||
|
|
||||||
This will apply all migrations at `db/dev.db`.
|
|
||||||
|
|
||||||
- `pnpm db:seed` seed the database.
|
|
||||||
- `pnpm dev` start coding.
|
|
||||||
|
|
||||||
## Technical skills required
|
|
||||||
|
|
||||||
- **Languages**: Node.js / Javascript / Typescript
|
|
||||||
- **Framework JS/TS**: [SvelteKit](https://kit.svelte.dev/) & [Fastify](https://www.fastify.io/)
|
|
||||||
- **Database ORM**: [Prisma.io](https://www.prisma.io/)
|
|
||||||
- **Docker Engine API**
|
|
||||||
|
|
||||||
## How to add a new service?
|
|
||||||
You can find all details [here](https://github.com/coollabsio/coolify-community-templates)
|
|
@ -105,6 +105,10 @@ ## Support
|
|||||||
- Email: [andras@coollabs.io](mailto:andras@coollabs.io)
|
- Email: [andras@coollabs.io](mailto:andras@coollabs.io)
|
||||||
- Discord: [Invitation](https://coollabs.io/discord)
|
- Discord: [Invitation](https://coollabs.io/discord)
|
||||||
|
|
||||||
|
## Development Contributions
|
||||||
|
|
||||||
|
Coolify is developed under the Apache License and you can help to make it grow → [Start coding!](./CONTRIBUTION.md)
|
||||||
|
|
||||||
## Financial Contributors
|
## Financial Contributors
|
||||||
|
|
||||||
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/coollabsio/contribute)]
|
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/coollabsio/contribute)]
|
||||||
|
@ -173,7 +173,13 @@ const host = '0.0.0.0';
|
|||||||
// Refresh and check templates
|
// Refresh and check templates
|
||||||
setInterval(async () => {
|
setInterval(async () => {
|
||||||
await refreshTemplates()
|
await refreshTemplates()
|
||||||
|
}, 60000)
|
||||||
|
|
||||||
|
setInterval(async () => {
|
||||||
await refreshTags()
|
await refreshTags()
|
||||||
|
}, 60000)
|
||||||
|
|
||||||
|
setInterval(async () => {
|
||||||
await migrateServicesToNewTemplate()
|
await migrateServicesToNewTemplate()
|
||||||
}, 60000)
|
}, 60000)
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import cuid from "cuid";
|
import cuid from "cuid";
|
||||||
import { decrypt, encrypt, fixType, generatePassword, getDomain, prisma } from "./lib/common";
|
import { decrypt, encrypt, fixType, generatePassword, prisma } from "./lib/common";
|
||||||
import { getTemplates } from "./lib/services";
|
import { getTemplates } from "./lib/services";
|
||||||
|
|
||||||
export async function migrateServicesToNewTemplate() {
|
export async function migrateServicesToNewTemplate() {
|
||||||
@ -253,6 +253,8 @@ async function umami(service: any, template: any) {
|
|||||||
await migrateSettings(settings, service, template);
|
await migrateSettings(settings, service, template);
|
||||||
await migrateSecrets(secrets, service);
|
await migrateSecrets(secrets, service);
|
||||||
|
|
||||||
|
await prisma.service.update({ where: { id: service.id }, data: { type: "umami-postgresql" } })
|
||||||
|
|
||||||
// Disconnect old service data
|
// Disconnect old service data
|
||||||
// await prisma.service.update({ where: { id: service.id }, data: { umami: { disconnect: true } } })
|
// await prisma.service.update({ where: { id: service.id }, data: { umami: { disconnect: true } } })
|
||||||
}
|
}
|
||||||
@ -440,6 +442,7 @@ async function plausibleAnalytics(service: any, template: any) {
|
|||||||
|
|
||||||
async function migrateSettings(settings: any[], service: any, template: any) {
|
async function migrateSettings(settings: any[], service: any, template: any) {
|
||||||
for (const setting of settings) {
|
for (const setting of settings) {
|
||||||
|
try {
|
||||||
if (!setting) continue;
|
if (!setting) continue;
|
||||||
let [name, value] = setting.split('@@@')
|
let [name, value] = setting.split('@@@')
|
||||||
let minio = name
|
let minio = name
|
||||||
@ -456,10 +459,14 @@ async function migrateSettings(settings: any[], service: any, template: any) {
|
|||||||
// console.log('Migrating setting', name, value, 'for service', service.id, ', service name:', service.name, 'variableName: ', variableName)
|
// console.log('Migrating setting', name, value, 'for service', service.id, ', service name:', service.name, 'variableName: ', variableName)
|
||||||
|
|
||||||
await prisma.serviceSetting.findFirst({ where: { name: minio, serviceId: service.id } }) || await prisma.serviceSetting.create({ data: { name: minio, value, variableName, service: { connect: { id: service.id } } } })
|
await prisma.serviceSetting.findFirst({ where: { name: minio, serviceId: service.id } }) || await prisma.serviceSetting.create({ data: { name: minio, value, variableName, service: { connect: { id: service.id } } } })
|
||||||
|
} catch(error) {
|
||||||
|
console.log(error)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
async function migrateSecrets(secrets: any[], service: any) {
|
async function migrateSecrets(secrets: any[], service: any) {
|
||||||
for (const secret of secrets) {
|
for (const secret of secrets) {
|
||||||
|
try {
|
||||||
if (!secret) continue;
|
if (!secret) continue;
|
||||||
let [name, value] = secret.split('@@@')
|
let [name, value] = secret.split('@@@')
|
||||||
if (!value || value === 'null') {
|
if (!value || value === 'null') {
|
||||||
@ -467,6 +474,9 @@ async function migrateSecrets(secrets: any[], service: any) {
|
|||||||
}
|
}
|
||||||
// console.log('Migrating secret', name, value, 'for service', service.id, ', service name:', service.name)
|
// console.log('Migrating secret', name, value, 'for service', service.id, ', service name:', service.name)
|
||||||
await prisma.serviceSecret.findFirst({ where: { name, serviceId: service.id } }) || await prisma.serviceSecret.create({ data: { name, value, service: { connect: { id: service.id } } } })
|
await prisma.serviceSecret.findFirst({ where: { name, serviceId: service.id } }) || await prisma.serviceSecret.create({ data: { name, value, service: { connect: { id: service.id } } } })
|
||||||
|
} catch(error) {
|
||||||
|
console.log(error)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
async function createVolumes(service: any, template: any) {
|
async function createVolumes(service: any, template: any) {
|
||||||
|
@ -17,7 +17,7 @@ import { day } from './dayjs';
|
|||||||
import { saveBuildLog } from './buildPacks/common';
|
import { saveBuildLog } from './buildPacks/common';
|
||||||
import { scheduler } from './scheduler';
|
import { scheduler } from './scheduler';
|
||||||
|
|
||||||
export const version = '3.11.1';
|
export const version = '3.11.2';
|
||||||
export const isDev = process.env.NODE_ENV === 'development';
|
export const isDev = process.env.NODE_ENV === 'development';
|
||||||
|
|
||||||
const algorithm = 'aes-256-ctr';
|
const algorithm = 'aes-256-ctr';
|
||||||
|
@ -49,10 +49,6 @@ export async function refreshTags() {
|
|||||||
}
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.log(error)
|
console.log(error)
|
||||||
throw {
|
|
||||||
status: 500,
|
|
||||||
message: 'Could not fetch templates from get.coollabs.io'
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return {};
|
return {};
|
||||||
@ -73,12 +69,7 @@ export async function refreshTemplates() {
|
|||||||
}
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.log(error)
|
console.log(error)
|
||||||
throw {
|
|
||||||
status: 500,
|
|
||||||
message: 'Could not fetch templates from get.coollabs.io'
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return {};
|
return {};
|
||||||
} catch ({ status, message }) {
|
} catch ({ status, message }) {
|
||||||
return errorHandler({ status, message });
|
return errorHandler({ status, message });
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import { FastifyPluginAsync } from 'fastify';
|
import { FastifyPluginAsync } from 'fastify';
|
||||||
import { checkUpdate, login, showDashboard, update, resetQueue, getCurrentUser, cleanupManually, restartCoolify, refreshTemplates } from './handlers';
|
import { checkUpdate, login, showDashboard, update, resetQueue, getCurrentUser, cleanupManually, restartCoolify } from './handlers';
|
||||||
import { GetCurrentUser } from './types';
|
import { GetCurrentUser } from './types';
|
||||||
|
|
||||||
export interface Update {
|
export interface Update {
|
||||||
@ -52,10 +52,6 @@ const root: FastifyPluginAsync = async (fastify): Promise<void> => {
|
|||||||
fastify.post('/internal/cleanup', {
|
fastify.post('/internal/cleanup', {
|
||||||
onRequest: [fastify.authenticate]
|
onRequest: [fastify.authenticate]
|
||||||
}, async (request) => await cleanupManually(request));
|
}, async (request) => await cleanupManually(request));
|
||||||
|
|
||||||
fastify.post('/internal/refreshTemplates', {
|
|
||||||
onRequest: [fastify.authenticate]
|
|
||||||
}, async () => await refreshTemplates());
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export default root;
|
export default root;
|
||||||
|
@ -79,9 +79,7 @@
|
|||||||
$isDeploymentEnabled = checkIfDeploymentEnabledServices($appSession.isAdmin, service);
|
$isDeploymentEnabled = checkIfDeploymentEnabledServices($appSession.isAdmin, service);
|
||||||
|
|
||||||
let statusInterval: any;
|
let statusInterval: any;
|
||||||
let loading = {
|
|
||||||
refreshTemplates: false
|
|
||||||
};
|
|
||||||
|
|
||||||
async function deleteService() {
|
async function deleteService() {
|
||||||
const sure = confirm($t('application.confirm_to_delete', { name: service.name }));
|
const sure = confirm($t('application.confirm_to_delete', { name: service.name }));
|
||||||
@ -106,20 +104,6 @@
|
|||||||
await startService();
|
await startService();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
async function refreshTemplate() {
|
|
||||||
try {
|
|
||||||
loading.refreshTemplates = true;
|
|
||||||
await post(`/internal/refreshTemplates`, {});
|
|
||||||
addToast({
|
|
||||||
message: 'Services refreshed.',
|
|
||||||
type: 'success'
|
|
||||||
});
|
|
||||||
} catch (error) {
|
|
||||||
return errorNotification(error);
|
|
||||||
} finally {
|
|
||||||
loading.refreshTemplates = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
async function stopService(skip = false) {
|
async function stopService(skip = false) {
|
||||||
if (skip) {
|
if (skip) {
|
||||||
$status.service.initialLoading = true;
|
$status.service.initialLoading = true;
|
||||||
@ -278,14 +262,6 @@
|
|||||||
Delete Service
|
Delete Service
|
||||||
</button>
|
</button>
|
||||||
{/if}
|
{/if}
|
||||||
{#if $page.url.pathname === `/services/${id}/configuration/type` && dev}
|
|
||||||
<button
|
|
||||||
disabled={loading.refreshTemplates}
|
|
||||||
class:loading={loading.refreshTemplates}
|
|
||||||
class="btn btn-sm btn-primary text-sm"
|
|
||||||
on:click={refreshTemplate}>Refresh Services List</button
|
|
||||||
>
|
|
||||||
{/if}
|
|
||||||
</div>
|
</div>
|
||||||
</nav>
|
</nav>
|
||||||
<div
|
<div
|
||||||
|
21
docs/contribution/GettingStarted.md
Normal file
21
docs/contribution/GettingStarted.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
## Getting Started
|
||||||
|
|
||||||
|
To contribute to `Coolify` development, you'll benefit from knowing the following:
|
||||||
|
|
||||||
|
- **Languages**
|
||||||
|
- [Node.js]() - 📚 [Introduction](https://nodejs.dev/en/learn/introduction-to-nodejs/)
|
||||||
|
- Javascript - 📚 [Learn Javascript](https://learnjavascript.online/)
|
||||||
|
- Typescript - 📚 [Learn@FreecodeCamp](https://www.freecodecamp.org/news/learn-typescript-beginners-guide/)
|
||||||
|
|
||||||
|
- **Framework JS/TS**
|
||||||
|
- [SvelteKit](https://kit.svelte.dev/) - 📚 [Tutorial](https://svelte.dev/tutorial/basics)
|
||||||
|
- [Fastify](https://www.fastify.io/)
|
||||||
|
|
||||||
|
- **Database ORM**
|
||||||
|
- [Prisma.io](https://www.prisma.io/) - 📚 [Quickstart](https://www.prisma.io/docs/getting-started/quickstart)
|
||||||
|
|
||||||
|
- **Docker**
|
||||||
|
- [Docker Engine API](https://docs.docker.com/engine/api/)
|
||||||
|
|
||||||
|
## How to add a new service?
|
||||||
|
You can find all details [here](https://github.com/coollabsio/coolify-community-templates)
|
10
docs/dev_setup/Container.md
Normal file
10
docs/dev_setup/Container.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
### Container based development flow (recommended and the easiest)
|
||||||
|
|
||||||
|
All you need is to
|
||||||
|
|
||||||
|
1. Install [Docker Engine 20.11+](https://docs.docker.com/engine/install/) on your local machine
|
||||||
|
2. Run `pnpm dev:container`.
|
||||||
|
|
||||||
|
It will build the base image for Coolify and start the development server inside Docker.
|
||||||
|
|
||||||
|
All required ports (3000, 3001) will be exposed to your host.
|
2
docs/dev_setup/DockerContiner.md
Normal file
2
docs/dev_setup/DockerContiner.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
### Inside a Docker container
|
||||||
|
# `WIP`
|
19
docs/dev_setup/GitPod.md
Normal file
19
docs/dev_setup/GitPod.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
### Gitpod
|
||||||
|
|
||||||
|
#### Option 1 - Prefered:
|
||||||
|
|
||||||
|
Follow the same steps as [container based development flow](./Container.md)
|
||||||
|
|
||||||
|
#### Option 2 - Manual setup:
|
||||||
|
|
||||||
|
1. Create a workspace from this repository,
|
||||||
|
1. run `pnpm install && pnpm db:push && pnpm db:seed`
|
||||||
|
1. and then `pnpm dev`.
|
||||||
|
|
||||||
|
All the required dependencies and packages has been configured for you already.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> Some packages, just `pack` are not installed in this way.
|
||||||
|
You cannot test all the features.
|
||||||
|
Please use the [container based development flow](./Container.md).
|
8
docs/dev_setup/GithubCodespaces.md
Normal file
8
docs/dev_setup/GithubCodespaces.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
### Github codespaces
|
||||||
|
|
||||||
|
If you have github codespaces enabled then you can just:
|
||||||
|
|
||||||
|
1. create a codespace and
|
||||||
|
2. run `pnpm dev` to run your the dev environment.
|
||||||
|
|
||||||
|
All the required dependencies and packages has been configured for you already.
|
17
docs/dev_setup/LocalMachine.md
Normal file
17
docs/dev_setup/LocalMachine.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
### Local Machine
|
||||||
|
|
||||||
|
At the moment, Coolify `doesn't support Windows`.
|
||||||
|
|
||||||
|
You must use `Linux` or `MacOS` or consider using Gitpod or Github Codespaces.
|
||||||
|
|
||||||
|
Install all the prerequisites manually to your host system.
|
||||||
|
If you would not like to install anything,
|
||||||
|
I suggest to use the [container based development flow](#container-based-development-flow-easiest).
|
||||||
|
|
||||||
|
- Due to the lock file, this repository is best with [pnpm](https://pnpm.io). I recommend you try and use `pnpm` because it is cool and efficient!
|
||||||
|
- You need to have [Docker Engine](https://docs.docker.com/engine/install/) installed locally.
|
||||||
|
- You need to have [Docker Compose Plugin](https://docs.docker.com/compose/install/compose-plugin/) installed locally.
|
||||||
|
- You need to have [GIT LFS Support](https://git-lfs.github.com/) installed locally.
|
||||||
|
|
||||||
|
Optional:
|
||||||
|
- To test Heroku buildpacks, you need [pack](https://github.com/buildpacks/pack) binary installed locally.
|
2
docs/dev_setup/Mac.md
Normal file
2
docs/dev_setup/Mac.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
### Mac Setup
|
||||||
|
|
1
docs/dev_setup/MacArm.md
Normal file
1
docs/dev_setup/MacArm.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
### Mac Setup
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "coolify",
|
"name": "coolify",
|
||||||
"description": "An open-source & self-hostable Heroku / Netlify alternative.",
|
"description": "An open-source & self-hostable Heroku / Netlify alternative.",
|
||||||
"version": "3.11.1",
|
"version": "3.11.2",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"repository": "github:coollabsio/coolify",
|
"repository": "github:coollabsio/coolify",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
Loading…
Reference in New Issue
Block a user