From 5402dd9cb67f7331d842fd60e054de954d36da17 Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Tue, 17 Mar 2020 22:10:22 +0000 Subject: [PATCH] docs: update summary section - Added table of contents. - Updated summary section. - Added 'Ansible Roles' and Additional features as subsections of summary. --- README.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 13a0cdd..3837bbd 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,39 @@ # Ansible Playbook for Pleroma +## Table of content + +- [Summary](#summary) + - [Ansible roles](#ansible-roles) + - [Additional features](#additional-features) +- [Requirements](#requirements) +- [Configuration](#configuration) +- [Secrets](#secrets) +- [Guide to setting up and running the playbook](#guide-to-setting-up-and-running-the-playbook) + ## Summary -This project was inspired by the official [Pleroma OTP installation guide](https://docs.pleroma.social/otp_en.html#content) -and contains a playbook which installs and configures Pleroma on a single Alpine Linux host. -It currently contains four roles, including: +This project is a configurable playbook that can install, configure and customize Pleroma on an Alpine Linux host. +The playbook is currently used to manage my personal instance at https://fedi.dananglin.me.uk. +It currently only supports installing Pleroma on a single host but will support installing it across multipe hosts in the future. -- **init:** merges the default configuration with the user's custom configuration. -- **pleroma-postgres:** installs and configures the PostgreSQL database. +This project was inspired by the official [Pleroma OTP installation guide](https://docs.pleroma.social/otp_en.html#content). + +### Ansible roles + +There are four roles used to install and configure Pleroma including: + +- **init:** merges the default configuration with your custom configuration. +- **pleroma-postgres:** installs and configures the Pleroma PostgreSQL database. - **pleroma-main:** installs/upgrades Pleroma and configures both the backend and frontend. - **pleroma-nginx:** installs and configures Nginx, creates SSL certificates using Let's Encrypt and adds support for proving your Pleroma site with Keybase. -This project is currently used to manage my personal instance at https://fedi.dananglin.me.uk. - -## Additional Features +### Additional features - **Let's Encrypt support:** This playbook creates a SSL certificate using Let's Encrypt. - **Keybase support:** Pleroma does not support Keybase out of the box but you can still prove that your ownership of your Pleroma site. -- **Custom default background:** Specify an image to use as the default background of your Pleroma site. +- **Set default background:** You can specify an image to use as the default background of your Pleroma site. +- **Upload custom themes:** You can upload custom Pleroma themes in to your Pleroma instance. +- **Set default theme:** You can specify the default Pleroma theme. ## Requirements