2016-09-02 14:21:20 +00:00
# libre.sh
2018-02-28 10:19:45 +00:00
[](#backers)
[](#sponsors)
2014-10-17 12:13:06 +00:00
2016-02-11 11:30:19 +00:00
## Introduction
2014-10-17 12:13:06 +00:00
2019-01-28 05:58:33 +00:00
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.
2015-03-10 12:40:23 +00:00
2017-04-06 19:31:37 +00:00
## Installation
[](https://fosdem.org/2017/schedule/event/libre_sh/)
To install it, follow the video above and instructions in `INSTALL.md` .
2015-03-10 12:40:23 +00:00
2016-09-02 14:21:20 +00:00
### What is libre.sh
2016-08-06 14:20:59 +00:00
2016-09-02 14:21:20 +00:00
libre.sh is a little framework to host Docker. It is simple and modular and respect the convention over configuration paradigm.
2016-08-06 14:20:59 +00:00
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
2015-03-10 12:40:23 +00:00
2016-02-11 11:30:19 +00:00
The PaaS is really modular, that's why it contains the strict necessary, then you'll probably want to add `system` modules or `applications` .
2015-03-10 12:40:23 +00:00
2016-08-06 14:20:59 +00:00
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.
2016-09-02 14:13:54 +00:00
### Support
You can use the following channels to request community support:
- [mailinglist/forum ](https://forum.indie.host/t/about-the-libre-sh-category/71 )
2019-01-28 22:00:50 +00:00
- [chat ](https://riot.allmende.io/#/room/#libre.sh:matrix.allmende.io )
2016-09-02 14:13:54 +00:00
2016-09-02 14:21:20 +00:00
For paid support, just send an inquiry to support@libre.sh.
2016-09-02 14:13:54 +00:00
All of this is hosted by libre.sh :)
2016-02-11 11:30:19 +00:00
## System modules
2015-03-10 12:40:23 +00:00
2016-02-11 11:30:19 +00:00
Here is a list of modules supported:
2016-08-06 14:20:59 +00:00
- https proxy:
2019-02-15 19:18:48 +00:00
- [HAProxy ](https://github.com/indiehosters/haproxy )
- [Nginx ](https://github.com/indiehosters/nginx )
2016-11-25 23:09:35 +00:00
- [monitoring ](https://github.com/indiehosters/monitoring )
2016-02-25 19:01:14 +00:00
- [git-puller ](https://github.com/indiehosters/git-puller )
- [backups ](https://github.com/indiehosters/backups )
2016-11-25 23:08:55 +00:00
2016-02-11 11:30:19 +00:00
Go to their respective page for more details.
2016-08-06 14:20:59 +00:00
### To install and start a module:
2016-02-11 11:30:19 +00:00
```
2016-02-25 19:01:14 +00:00
cd /system/
git clone module
2016-08-06 14:20:59 +00:00
cd module
2016-11-26 16:30:39 +00:00
libre enable
libre start
2016-08-06 14:20:59 +00:00
```
## Applications
2016-02-11 11:30:19 +00:00
2016-08-06 14:20:59 +00:00
### Installation
2016-02-11 11:30:19 +00:00
2016-08-06 14:20:59 +00:00
To install application `wordpress` on `example.org` , first make point example.org to your server IP, and then, just run:
2015-03-10 12:40:23 +00:00
```
2016-11-26 16:30:39 +00:00
libre provision -a github.com/indiehosters/wordpress -u example.org -s
2015-03-10 12:40:23 +00:00
```
2016-11-26 16:30:39 +00:00
Run `libre provision` for more details on the capabilities of the script.
2015-03-10 12:40:23 +00:00
2016-11-26 16:30:39 +00:00
## To debug a module or an application:
2016-08-06 14:20:59 +00:00
```
2016-11-26 16:30:39 +00:00
libre ps
libre logs -f --tail=100
libre stop
libre restart
2016-08-06 14:20:59 +00:00
```
2016-02-11 11:30:19 +00:00
## Contributing
2015-03-11 16:31:04 +00:00
2016-02-25 19:01:14 +00:00
If you have any issue (something not working, missing doc), please do report an issue here! Thanks
2015-03-11 16:31:04 +00:00
2016-02-11 11:30:19 +00:00
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!
2014-09-26 12:57:09 +00:00
2016-02-11 11:30:19 +00:00
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!
2018-02-28 10:19:45 +00:00
## Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
2018-03-03 09:59:32 +00:00
< a href = "https://github.com/indiehosters/libre.sh/graphs/contributors" > < img src = "https://opencollective.com/libresh/contributors.svg?width=890&button=false" / > < / a >
2018-02-28 10:19:45 +00:00
## 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 >
