README.md 3.1 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.md`.
Pierre Ozoux's avatar
Pierre Ozoux committed
8

Pierre Ozoux's avatar
Pierre Ozoux committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
### What is LibrePaaS

LibrePaaS is a little framework to host Docker. It is simple and modular and respect the convention over configuration paradigm.

This is aimed at Hosters to manage a huge amount of different web application, and a quantity of domain names related with emails and so on.

It is currently installed at 3 different hosters in production and hosting ~20 different web applications, with ~500 containers.

Once well installed, in one bash command, you'll be able to:
 - buy a domain name
 - configure DNS for it
 - configure email for it
 - configure dkim for that domain
 - configure dmarc for that domain
 - configure autoconfig for that domain
 - install and start a web application on that domain (WordPress, Nextcloud, piwik...)
 - provision a TLS cert on that domain

Amazing, right?

### Modular
Pierre Ozoux's avatar
Pierre Ozoux committed
30

Pierre Ozoux's avatar
Pierre Ozoux committed
31
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
32

Pierre Ozoux's avatar
Pierre Ozoux committed
33 34
It contains 2 [unit-files](https://github.com/indiehosters/LibrePaaS/tree/master/unit-files) to manage system modules and applications, start them at boot, and load the appropriate environment.

Pierre Ozoux's avatar
Pierre Ozoux committed
35 36 37 38 39 40 41 42 43 44
### Support

You can use the following channels to request community support:
 - [mailinglist/forum](https://forum.indie.host/t/about-the-libre-sh-category/71)
 - [chat](https://chat.indie.host/channel/libre.sh)

For paid support, just send an inquiry to libre.sh@indie.host.

All of this is hosted by libre.sh :)

Pierre Ozoux's avatar
Pierre Ozoux committed
45
## System modules
Pierre Ozoux's avatar
Pierre Ozoux committed
46

Pierre Ozoux's avatar
Pierre Ozoux committed
47
Here is a list of modules supported:
Pierre Ozoux's avatar
Pierre Ozoux committed
48 49 50
 - https proxy:
  - [HAProxy](https://github.com/indiehosters/haproxy)
  - [Nginx](https://github.com/indiehosters/nginx)
Pierre Ozoux's avatar
Pierre Ozoux committed
51 52 53 54
 - [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
55 56
Go to their respective page for more details.

Pierre Ozoux's avatar
Pierre Ozoux committed
57
### To install and start a module:
Pierre Ozoux's avatar
Pierre Ozoux committed
58 59

```
Pierre Ozoux's avatar
Pierre Ozoux committed
60 61
cd /system/
git clone module
Pierre Ozoux's avatar
Pierre Ozoux committed
62
cd module
Pierre Ozoux's avatar
Pierre Ozoux committed
63
systemctl enable s@module
Pierre Ozoux's avatar
Pierre Ozoux committed
64 65 66 67 68
start
```

### To debug a module:

Pierre Ozoux's avatar
Pierre Ozoux committed
69
```
Pierre Ozoux's avatar
Pierre Ozoux committed
70 71 72 73 74 75 76
docker-compose ps
docker-compose logs
stop
restart
```

## Applications
Pierre Ozoux's avatar
Pierre Ozoux committed
77

Pierre Ozoux's avatar
Pierre Ozoux committed
78
### Installation
Pierre Ozoux's avatar
Pierre Ozoux committed
79

Pierre Ozoux's avatar
Pierre Ozoux committed
80
To install application `wordpress` on `example.org`, first make point example.org to your server IP, and then, just run:
Pierre Ozoux's avatar
Pierre Ozoux committed
81 82

```
Pierre Ozoux's avatar
Pierre Ozoux committed
83
provision -a github.com/indiehosters/wordpress -u example.org -s
Pierre Ozoux's avatar
Pierre Ozoux committed
84 85
```

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

Pierre Ozoux's avatar
Pierre Ozoux committed
88 89 90 91 92 93 94 95 96 97
### debug an application

```
docker-compose ps
docker-compose logs
stop
start
restart
```

Pierre Ozoux's avatar
Pierre Ozoux committed
98
## Contributing
99

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

Pierre Ozoux's avatar
Pierre Ozoux committed
102
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
103

Pierre Ozoux's avatar
Pierre Ozoux committed
104 105 106 107 108 109 110
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!