compose-website/README.md

libre.sh

Introduction

A PaaS that is aimed at hosting free software \o/

To install it, follow instructions in INSTALL.md.

What is libre.sh

libre.sh 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

The PaaS is really modular, that's why it contains the strict necessary, then you'll probably want to add system modules or applications.

It contains 2 unit-files to manage system modules and applications, start them at boot, and load the appropriate environment.

Support

You can use the following channels to request community support:

• mailinglist/forum
• chat

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

All of this is hosted by libre.sh :)

System modules

Here is a list of modules supported:

• https proxy:
• HAProxy
• Nginx
• git-puller
• backups
• sshd
• pull-backups

Go to their respective page for more details.

To install and start a module:

cd /system/
git clone module
cd module
systemctl enable s@module
start

To debug a module:

docker-compose ps
docker-compose logs
stop
restart

Applications

Installation

To install application wordpress on example.org, first make point example.org to your server IP, and then, just run:

provision -a github.com/indiehosters/wordpress -u example.org -s

Run provision for more details on the capabilities of the script.

debug an application

docker-compose ps
docker-compose logs
stop
start
restart

Contributing

If you have any issue (something not working, missing doc), please do report an issue here! Thanks

This system is used in production at IndieHosters so it is maintained. If you use it, please tell us, and we'll be really happy to update this README!

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!