Skip to content
README.md 1.51 KiB
Newer Older
Pierre Ozoux's avatar
Pierre Ozoux committed
# LibrePaaS
Pierre Ozoux's avatar
Pierre Ozoux committed
## Introduction
Pierre Ozoux's avatar
Pierre Ozoux committed
A PaaS that is aimed at hosting free software \o/
Pierre Ozoux's avatar
Pierre Ozoux committed
To install it, follow instructions in `INSTALL.nd`.
Pierre Ozoux's avatar
Pierre Ozoux committed
## Modular
Pierre Ozoux's avatar
Pierre Ozoux committed
The PaaS is really modular, that's why it contains the strict necessary, then you'll probably want to add `system` modules or `applications`.
Pierre Ozoux's avatar
Pierre Ozoux committed
## System modules
Pierre Ozoux's avatar
Pierre Ozoux committed
Here is a list of modules supported:
Pierre Ozoux's avatar
Pierre Ozoux committed
 - [HAProxy](https://github.com/indiehosters/haproxy)
 - [git-puller](https://github.com/indiehosters/git-puller)
 - [backups](https://github.com/indiehosters/backups)
 - [sshd](https://github.com/indiehosters/sshd)
 - [pull-backups](https://github.com/indiehosters/pull-backups)
Pierre Ozoux's avatar
Pierre Ozoux committed
Go to their respective page for more details.

To install and start a module:

```
Pierre Ozoux's avatar
Pierre Ozoux committed
cd /system/
git clone module
Pierre Ozoux's avatar
Pierre Ozoux committed
systemctl enable s@module
systemctl start s@module
```

## Application modules

To install application `wordpress` on `example.org`, just run:
Pierre Ozoux's avatar
Pierre Ozoux committed
provision -a github.com/indiehosters/wordpress -u example.org -s
Pierre Ozoux's avatar
Pierre Ozoux committed
Run `provision` for more details on the capabilities of the script.
Pierre Ozoux's avatar
Pierre Ozoux committed
## Contributing
Pierre Ozoux's avatar
Pierre Ozoux committed
If you have any issue (something not working, missing doc), please do report an issue here! Thanks
Pierre Ozoux's avatar
Pierre Ozoux committed
This system is used in production at [IndieHosters](https://indiehosters.net/) so it is maintained. If you use it, please tell us, and we'll be really happy to update this README!
pierreozoux's avatar
pierreozoux committed

Pierre Ozoux's avatar
Pierre Ozoux committed
You can help us by:
 - starring this project
 - sending us a thanks email
 - reporting bugs
 - writing documentation/blog on how you got up and running in 5mins
 - writing more documentation
 - sending us cake :) We loove cake!