rosslh/coolify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updates on docs

Browse source
This commit is contained in:
Andras Bacsai 2022-04-16 22:31:30 +02:00
parent bf01e9e29f
commit 07aa285b27
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -6,7 +6,7 @@ # Technical skills required
- Node.js / Javascript - Node.js / Javascript
- Svelte / SvelteKit - Svelte / SvelteKit
- Prisma.io - Prisma.io / SQL
# Recommended Pull Request Guideline # Recommended Pull Request Guideline
@ -18,6 +18,8 @@ # Recommended Pull Request Guideline
- Write a proper description - Write a proper description
- Open the pull request to review - Open the pull request to review
---
# How to start after you set up your local fork? # How to start after you set up your local fork?
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! 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!
@ -45,7 +47,7 @@ ## Tricky parts
--- ---
# Adding new services # How to add new services
You can add any open-source and self-hostable software (service/application) to Coolify if the following statements are true: You can add any open-source and self-hostable software (service/application) to Coolify if the following statements are true:
@ -90,7 +92,7 @@ ## Backend
- You need to define a compose file as `const composeFile: ComposeFile` found in [src/routes/services/[id]/minio/start.json.ts](src/routes/services/[id]/minio/start.json.ts) - You need to define a compose file as `const composeFile: ComposeFile` found in [src/routes/services/[id]/minio/start.json.ts](src/routes/services/[id]/minio/start.json.ts)
IMPORTANT: It should contain `all the default environment variables` that are required for the service to function correctly and `all the volumes to persist data` in restarts. **IMPORTANT:** It should contain `all the default environment variables` that are required for the service to function correctly and `all the volumes to persist data` in restarts.
- You could also define an `HTTP` or `TCP` proxy for every other port that should be proxied to your server. (See `startHttpProxy` and `startTcpProxy` functions) - You could also define an `HTTP` or `TCP` proxy for every other port that should be proxied to your server. (See `startHttpProxy` and `startTcpProxy` functions)