README.md 6.28 KB
Newer Older
Pierre Ozoux's avatar
Pierre Ozoux committed
1
# libre.sh
2 3
[![Backers on Open Collective](https://opencollective.com/libresh/backers/badge.svg)](#backers)
 [![Sponsors on Open Collective](https://opencollective.com/libresh/sponsors/badge.svg)](#sponsors) 
4

Pierre Ozoux's avatar
Pierre Ozoux committed
5
## Introduction
6

Pierre Ozoux's avatar
Pierre Ozoux committed
7 8 9 10 11 12 13 14 15 16 17
A ecosystem that is aimed at hosting free software \o/

We are working on bootstrapping an ecosystem of tools to facilitate the hosting of free software.
Think of it as
 - [ISPconfig](https://www.ispconfig.org/)
 - FLOSS [cpanel](https://www.cpanel.net/products/)
 - [cloudron](https://cloudron.io/) with email

for [kubernetes](https://kubernetes.io/).

This ecosystem can be deployed on [Raspberries](https://kubecloud.io/setting-up-a-kubernetes-1-11-raspberry-pi-cluster-using-kubeadm-952bbda329c8) or on popular cloud providers and scale globally or anything in between. We can affirm that it scales globally because it is based on kubernetes, a tool developped from the experience of Google hosting containers at scale.
Pierre Ozoux's avatar
Pierre Ozoux committed
18

Pierre Ozoux's avatar
Pierre Ozoux committed
19 20 21 22 23
## 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
24

Pierre Ozoux's avatar
Pierre Ozoux committed
25
### What is libre.sh
Pierre Ozoux's avatar
Pierre Ozoux committed
26

Pierre Ozoux's avatar
Pierre Ozoux committed
27
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
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

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
46

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

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

You can use the following channels to request community support:
 - [mailinglist/forum](https://forum.indie.host/t/about-the-libre-sh-category/71)
Michel Memeteau's avatar
Michel Memeteau committed
55
 - [chat](https://riot.allmende.io/#/room/#libre.sh:matrix.allmende.io)
Pierre Ozoux's avatar
Pierre Ozoux committed
56

Pierre Ozoux's avatar
Pierre Ozoux committed
57
For paid support, just send an inquiry to support@libre.sh.
Pierre Ozoux's avatar
Pierre Ozoux committed
58 59 60

All of this is hosted by libre.sh :)

Pierre Ozoux's avatar
Pierre Ozoux committed
61
## System modules
Pierre Ozoux's avatar
Pierre Ozoux committed
62

Pierre Ozoux's avatar
Pierre Ozoux committed
63
Here is a list of modules supported:
Pierre Ozoux's avatar
Pierre Ozoux committed
64
 - https proxy:
Pierre Ozoux's avatar
Pierre Ozoux committed
65 66
   - [HAProxy](https://github.com/indiehosters/haproxy)
   - [Nginx](https://github.com/indiehosters/nginx)
67
 - [monitoring](https://github.com/indiehosters/monitoring)
Pierre Ozoux's avatar
Pierre Ozoux committed
68 69
 - [git-puller](https://github.com/indiehosters/git-puller)
 - [backups](https://github.com/indiehosters/backups)
Pierre Ozoux's avatar
typo  
Pierre Ozoux committed
70

Pierre Ozoux's avatar
Pierre Ozoux committed
71 72
Go to their respective page for more details.

Pierre Ozoux's avatar
Pierre Ozoux committed
73
### To install and start a module:
Pierre Ozoux's avatar
Pierre Ozoux committed
74 75

```
Pierre Ozoux's avatar
Pierre Ozoux committed
76 77
cd /system/
git clone module
Pierre Ozoux's avatar
Pierre Ozoux committed
78
cd module
79 80
libre enable
libre start
Pierre Ozoux's avatar
Pierre Ozoux committed
81 82 83
```

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

Pierre Ozoux's avatar
Pierre Ozoux committed
85
### Installation
Pierre Ozoux's avatar
Pierre Ozoux committed
86

Pierre Ozoux's avatar
Pierre Ozoux committed
87
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
88 89

```
90
libre provision -a github.com/indiehosters/wordpress -u example.org -s
Pierre Ozoux's avatar
Pierre Ozoux committed
91 92
```

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

95
## To debug a module or an application:
Pierre Ozoux's avatar
Pierre Ozoux committed
96 97

```
98 99 100 101
libre ps
libre logs -f --tail=100
libre stop
libre restart
Pierre Ozoux's avatar
Pierre Ozoux committed
102 103
```

Pierre Ozoux's avatar
Pierre Ozoux committed
104
## Contributing
105

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

Pierre Ozoux's avatar
Pierre Ozoux committed
108
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
109

Pierre Ozoux's avatar
Pierre Ozoux committed
110 111 112 113 114 115 116
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!
117 118 119 120

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
Samuel Laulhau's avatar
Samuel Laulhau committed
121
<a href="https://github.com/indiehosters/libre.sh/graphs/contributors"><img src="https://opencollective.com/libresh/contributors.svg?width=890&button=false" /></a>
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146


## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/libresh#backer)]

<a href="https://opencollective.com/libresh#backers" target="_blank"><img src="https://opencollective.com/libresh/backers.svg?width=890"></a>


## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/libresh#sponsor)]

<a href="https://opencollective.com/libresh/sponsor/0/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/1/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/2/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/3/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/4/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/5/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/6/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/7/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/8/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/libresh/sponsor/9/website" target="_blank"><img src="https://opencollective.com/libresh/sponsor/9/avatar.svg"></a>