diff --git a/README.md b/README.md index bcdb32750..814f3b006 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,28 @@ the dashboard, database addons, graph container, base image etc. Cloudron also r on external services such as the App Store for apps to be installed. As such, don't clone this repo and npm install and expect something to work. +## Development + +This is the backend code of Cloudron. The frontend code is [here](https://git.cloudron.io/cloudron/dashboard). + +The way to develop is to first install a full instance of Cloudron in a VM. Then you can use the [hotfix](https://git.cloudron.io/cloudron/cloudron-machine) +tool to patch the VM with the latest code. + +``` +SSH_PASSPHRASE=sshkeypassword cloudron-machine hotfix --cloudron my.example.com --release 6.0.0 --ssh-key keyname +``` + +## License + +Please note that the Cloudron code is under a source-available license. This is not the same as an +open source license but ensures the code is available for introspection (and hacking!). + +## Contributions + +Just to give some heads up, we are a bit restrictive in merging changes. We are a small team and +would like to keep our maintenance burden low. It might be best to discuss features first in the [forum](https://forum.cloudron.io), +to also figure out how many other people will use it to justify maintenance for a feature. + ## Support * [Documentation](https://docs.cloudron.io/)