README.md 3.33 KB
Newer Older
Pierre Ozoux's avatar
Pierre Ozoux committed
1
# libre.sh
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 8 9 10 11
## Installation

[![ScreenShot](https://cloud.pierre-o.fr/index.php/apps/files_sharing/ajax/publicpreview.php?x=1364&y=283&a=true&file=preview.png&t=KlxYYFT59GirMJa&scalingup=0)](https://fosdem.org/2017/schedule/event/libre_sh/)

To install it, follow the video above and instructions in `INSTALL.md`.
Pierre Ozoux's avatar
Pierre Ozoux committed
12

Pierre Ozoux's avatar
Pierre Ozoux committed
13
### What is libre.sh
Pierre Ozoux's avatar
Pierre Ozoux committed
14

Pierre Ozoux's avatar
Pierre Ozoux committed
15
libre.sh is a little framework to host Docker. It is simple and modular and respect the convention over configuration paradigm.
Pierre Ozoux's avatar
Pierre Ozoux committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

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
34

Pierre Ozoux's avatar
Pierre Ozoux committed
35
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
36

Pierre Ozoux's avatar
Pierre Ozoux committed
37 38
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
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)

Pierre Ozoux's avatar
Pierre Ozoux committed
45
For paid support, just send an inquiry to support@libre.sh.
Pierre Ozoux's avatar
Pierre Ozoux committed
46 47 48

All of this is hosted by libre.sh :)

Pierre Ozoux's avatar
Pierre Ozoux committed
49
## System modules
Pierre Ozoux's avatar
Pierre Ozoux committed
50

Pierre Ozoux's avatar
Pierre Ozoux committed
51
Here is a list of modules supported:
Pierre Ozoux's avatar
Pierre Ozoux committed
52 53 54
 - https proxy:
  - [HAProxy](https://github.com/indiehosters/haproxy)
  - [Nginx](https://github.com/indiehosters/nginx)
55 56
 - [logs](https://github.com/indiehosters/logs)
 - [monitoring](https://github.com/indiehosters/monitoring)
Pierre Ozoux's avatar
Pierre Ozoux committed
57 58 59
 - [git-puller](https://github.com/indiehosters/git-puller)
 - [backups](https://github.com/indiehosters/backups)
 - [sshd](https://github.com/indiehosters/sshd)
Pierre Ozoux's avatar
typo  
Pierre Ozoux committed
60

Pierre Ozoux's avatar
Pierre Ozoux committed
61 62
Go to their respective page for more details.

Pierre Ozoux's avatar
Pierre Ozoux committed
63
### To install and start a module:
Pierre Ozoux's avatar
Pierre Ozoux committed
64 65

```
Pierre Ozoux's avatar
Pierre Ozoux committed
66 67
cd /system/
git clone module
Pierre Ozoux's avatar
Pierre Ozoux committed
68
cd module
69 70
libre enable
libre start
Pierre Ozoux's avatar
Pierre Ozoux committed
71 72 73
```

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

Pierre Ozoux's avatar
Pierre Ozoux committed
75
### Installation
Pierre Ozoux's avatar
Pierre Ozoux committed
76

Pierre Ozoux's avatar
Pierre Ozoux committed
77
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
78 79

```
80
libre provision -a github.com/indiehosters/wordpress -u example.org -s
Pierre Ozoux's avatar
Pierre Ozoux committed
81 82
```

83
Run `libre provision` for more details on the capabilities of the script.
Pierre Ozoux's avatar
Pierre Ozoux committed
84

85
## To debug a module or an application:
Pierre Ozoux's avatar
Pierre Ozoux committed
86 87

```
88 89 90 91
libre ps
libre logs -f --tail=100
libre stop
libre restart
Pierre Ozoux's avatar
Pierre Ozoux committed
92 93
```

Pierre Ozoux's avatar
Pierre Ozoux committed
94
## Contributing
95

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

Pierre Ozoux's avatar
Pierre Ozoux committed
98
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
99

Pierre Ozoux's avatar
Pierre Ozoux committed
100 101 102 103 104 105 106
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!