README.md 1.51 KB
Newer Older
Pierre Ozoux's avatar
Pierre Ozoux committed
1
# LibrePaaS
2

Pierre Ozoux's avatar
Pierre Ozoux committed
3
## Introduction
4

Pierre Ozoux's avatar
Pierre Ozoux committed
5
A PaaS that is aimed at hosting free software \o/
Pierre Ozoux's avatar
Pierre Ozoux committed
6

Pierre Ozoux's avatar
Pierre Ozoux committed
7
To install it, follow instructions in `INSTALL.nd`.
Pierre Ozoux's avatar
Pierre Ozoux committed
8

Pierre Ozoux's avatar
Pierre Ozoux committed
9
## Modular
Pierre Ozoux's avatar
Pierre Ozoux committed
10

Pierre Ozoux's avatar
Pierre Ozoux committed
11
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
12

Pierre Ozoux's avatar
Pierre Ozoux committed
13
## System modules
Pierre Ozoux's avatar
Pierre Ozoux committed
14

Pierre Ozoux's avatar
Pierre Ozoux committed
15
Here is a list of modules supported:
Pierre Ozoux's avatar
Pierre Ozoux committed
16 17 18 19 20
 - [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
21 22 23 24 25
Go to their respective page for more details.

To install and start a module:

```
Pierre Ozoux's avatar
Pierre Ozoux committed
26 27
cd /system/
git clone module
Pierre Ozoux's avatar
Pierre Ozoux committed
28 29 30 31 32 33 34
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
35 36

```
Pierre Ozoux's avatar
Pierre Ozoux committed
37
provision -a github.com/indiehosters/wordpress -u example.org -s
Pierre Ozoux's avatar
Pierre Ozoux committed
38 39
```

Pierre Ozoux's avatar
Pierre Ozoux committed
40
Run `provision` for more details on the capabilities of the script.
Pierre Ozoux's avatar
Pierre Ozoux committed
41

Pierre Ozoux's avatar
Pierre Ozoux committed
42
## Contributing
43

Pierre Ozoux's avatar
Pierre Ozoux committed
44
If you have any issue (something not working, missing doc), please do report an issue here! Thanks
45

Pierre Ozoux's avatar
Pierre Ozoux committed
46
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
47

Pierre Ozoux's avatar
Pierre Ozoux committed
48 49 50 51 52 53 54
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!