Commit dc50db57 authored by Jon Richter's avatar Jon Richter
Browse files

reify READMEs into documentation

parent af5b048b
Loading
Loading
Loading
Loading
+23 −1
Original line number Diff line number Diff line
# compose.libre.sh
# `libre.sh` *Compose Edition*

[![Backers on Open Collective](https://opencollective.com/libresh/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/libresh/sponsors/badge.svg)](#sponsors)

> An ecosystem to ease free software hosting \o/

## What is `libre.sh`?

[`libre.sh`](https://libre.sh/), Compose Edition, is a little framework to host Docker Compose in systemd. It is simple, modular and puts convention over configuration.

This is aimed at hosters to manage a large amount of web applications and a quantity of domain names.

It is currently installed at three different hosters in production.

When installed, use it to:

- buy a domain name
- configure DNS
- configure email (with dkim, dmarc, autoconfig)
- install and start a web application on that domain (WordPress, Nextcloud, Matomo...)
- provision a TLS certificate on that domain

Amazing, right?

content/about.md

0 → 100644
+15 −0
Original line number Diff line number Diff line
---
weight: 100
---

# About

[libre.sh](https://libre.sh/) is an ecosystem of libre hosting platforms for community infrastructure.

## 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
 - Sandstorm https://sandstorm.io/
 - Cloudron https://git.cloudron.io/cloudron/box
+46 −0
Original line number Diff line number Diff line
---
title: 'Contributing'
weight: 90
---

# 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](https://indiehosters.net/) 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!

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/indiehosters/libre.sh/graphs/contributors"><img src="https://opencollective.com/libresh/contributors.svg?width=890&button=false" /></a>


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

content/docs/applications.md

deleted100644 → 0
+0 −10
Original line number Diff line number Diff line
---
title: "Applications"
weight: 1
# bookFlatSection: false
# bookToc: true
# bookHidden: false
# bookCollapseSection: false
# bookComments: false
# bookSearchExclude: false
---

content/docs/system-modules.md

deleted100644 → 0
+0 −10
Original line number Diff line number Diff line
---
title: "System Modules"
weight: 1
# bookFlatSection: false
# bookToc: true
# bookHidden: false
# bookCollapseSection: false
# bookComments: false
# bookSearchExclude: false
---
Loading