From 03c66debc259dfd68db80d89d0f6e5b0732ac969 Mon Sep 17 00:00:00 2001 From: Felix Ableitner Date: Wed, 15 May 2019 14:10:52 +0200 Subject: [PATCH] Update readme --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14dd613..fe80e05 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ # Peertube setup with Ansible and Docker-Compose +This repo lets you easily setup a Peertube server based on docker-compose. + +## Features + +- automatic Let's Encrypt certificate handling via Traefik +- file caching with nginx (to limit backend access and Peertube CPU usage) +- email sending works out of the box + ## Setup +Clone the repo onto your local machine. + Copy `inventory.example` to `inventory`, and configure the hosts you want to work with. -Install Python and Ansible: +Install Python and Ansible on your local machine: apt install python pip2 install ansible @@ -13,4 +23,8 @@ Run the playbook: ansible-playbook --become peertube.yml -Note: If you run this on an existing server, make sure the file `passwords/*your-server*/postgres` exists and contains the correct password. Otherwise Ansible will change the password in Peertube, and it won't be able to connect to the database. +The first time you run it, Ansible will output the root password. + +Note: If you use this for an existing Peertube instance, make sure the file +`passwords/*your-server*/postgres` exists and contains the correct password. Otherwise +Ansible will change the password in Peertube, and it won't be able to connect to the database.