archives/pleroma-ansible-playbook
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update summary section

Browse source 
- Added table of contents.
- Updated summary section.
- Added 'Ansible Roles' and Additional
features as subsections of summary.
This commit is contained in:
Dan Anglin 2020-03-17 22:10:22 +00:00
parent 309a569c00
commit 5402dd9cb6
No known key found for this signature in database
GPG key ID: 7AC2B18EC1D09F27
1 changed files with 25 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,23 +1,39 @@
# Ansible Playbook for Pleroma # 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 ## Summary
This project was inspired by the official [Pleroma OTP installation guide](https://docs.pleroma.social/otp_en.html#content) This project is a configurable playbook that can install, configure and customize Pleroma on an Alpine Linux host.
and contains a playbook which installs and configures Pleroma on a single Alpine Linux host. The playbook is currently used to manage my personal instance at https://fedi.dananglin.me.uk.
It currently contains four roles, including: 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. This project was inspired by the official [Pleroma OTP installation guide](https://docs.pleroma.social/otp_en.html#content).
- **pleroma-postgres:** installs and configures the PostgreSQL database.
### 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-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. - **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. - **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. - **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 ## Requirements