README.md 6.6 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

Michel Memeteau's avatar
Michel Memeteau committed
7
An ecosystem to ease  free software hosting \o/
Pierre Ozoux's avatar
Pierre Ozoux committed
8 9 10 11 12 13 14 15

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


Michel Memeteau's avatar
Michel Memeteau committed
16 17 18 19 20 21
  * Libre.sh V1 (Stable) is using docker-compose 
  * Libre.sh V2 (Alpha) is using [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 V2 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
22

Pierre Ozoux's avatar
Pierre Ozoux committed
23 24 25
## Installation


Michel Memeteau's avatar
Michel Memeteau committed
26 27

To install it, follow the instructions in `INSTALL_LINUX.md` : https://lab.libreho.st/libre.sh/compose.libre.sh/blob/master/INSTALL_LINUX.md
Pierre Ozoux's avatar
Pierre Ozoux committed
28

Pierre Ozoux's avatar
Pierre Ozoux committed
29
### What is libre.sh
Pierre Ozoux's avatar
Pierre Ozoux committed
30

Pierre Ozoux's avatar
Pierre Ozoux committed
31
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
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

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
50

Pierre Ozoux's avatar
Pierre Ozoux committed
51
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
52

Pa's avatar
Pa committed
53
It contains 2 [unit-files](https://lab.libreho.st/libre.sh/compose.libre.sh/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
54

Pierre Ozoux's avatar
Pierre Ozoux committed
55 56 57 58
### 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
59
 - [chat](https://riot.allmende.io/#/room/#libre.sh:matrix.allmende.io)
Pierre Ozoux's avatar
Pierre Ozoux committed
60

Pierre Ozoux's avatar
Pierre Ozoux committed
61
For paid support, just send an inquiry to support@libre.sh.
Pierre Ozoux's avatar
Pierre Ozoux committed
62

Michel Memeteau's avatar
Michel Memeteau committed
63 64
You can also watch the Fosdem Video : [Video Fosdem](https://fosdem.org/2017/schedule/event/libre_sh/)

Pierre Ozoux's avatar
Pierre Ozoux committed
65 66
All of this is hosted by libre.sh :)

Pierre Ozoux's avatar
Pierre Ozoux committed
67
## System modules
Pierre Ozoux's avatar
Pierre Ozoux committed
68

Pierre Ozoux's avatar
Pierre Ozoux committed
69
Here is a list of modules supported:
Pierre Ozoux's avatar
Pierre Ozoux committed
70
 - https proxy:
Pierre Ozoux's avatar
Pierre Ozoux committed
71 72
   - [HAProxy](https://github.com/indiehosters/haproxy)
   - [Nginx](https://github.com/indiehosters/nginx)
73
 - [monitoring](https://github.com/indiehosters/monitoring)
Pierre Ozoux's avatar
Pierre Ozoux committed
74 75
 - [git-puller](https://github.com/indiehosters/git-puller)
 - [backups](https://github.com/indiehosters/backups)
Pierre Ozoux's avatar
typo  
Pierre Ozoux committed
76

Pierre Ozoux's avatar
Pierre Ozoux committed
77 78
Go to their respective page for more details.

Pierre Ozoux's avatar
Pierre Ozoux committed
79
### To install and start a module:
Pierre Ozoux's avatar
Pierre Ozoux committed
80 81

```
Pierre Ozoux's avatar
Pierre Ozoux committed
82 83
cd /system/
git clone module
Pierre Ozoux's avatar
Pierre Ozoux committed
84
cd module
85 86
libre enable
libre start
Pierre Ozoux's avatar
Pierre Ozoux committed
87 88 89
```

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

Pierre Ozoux's avatar
Pierre Ozoux committed
91
### Installation
Pierre Ozoux's avatar
Pierre Ozoux committed
92

Pierre Ozoux's avatar
Pierre Ozoux committed
93
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
94 95

```
96
libre provision -a github.com/indiehosters/wordpress -u example.org -s
Pierre Ozoux's avatar
Pierre Ozoux committed
97 98
```

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

101
## To debug a module or an application:
Pierre Ozoux's avatar
Pierre Ozoux committed
102 103

```
104 105 106 107
libre ps
libre logs -f --tail=100
libre stop
libre restart
Pierre Ozoux's avatar
Pierre Ozoux committed
108 109
```

Pierre Ozoux's avatar
Pierre Ozoux committed
110
## Contributing
111

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

Pierre Ozoux's avatar
Pierre Ozoux committed
114
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
115

Pierre Ozoux's avatar
Pierre Ozoux committed
116 117 118 119 120 121 122
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!
123 124 125 126

## Contributors

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


## 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>


Michel Memeteau's avatar
Michel Memeteau committed
153 154 155 156 157 158 159 160
## Other projects


Simplifying web application hosting has always been a goal for a lot of other projects, here is some project that share goals with libre.sh



 - Yunohost https://yunohost.org
Michel Memeteau's avatar
Michel Memeteau committed
161
 - Sandstorm https://sandstorm.io/
Michel Memeteau's avatar
Michel Memeteau committed
162
 - Cloudron https://git.cloudron.io/cloudron/box
Michel Memeteau's avatar
Michel Memeteau committed
163 164