Update readme
This commit is contained in:
parent
32c3103945
commit
cd2ff6459d
2 changed files with 6 additions and 39 deletions
44
README.md
44
README.md
|
@ -1,42 +1,10 @@
|
|||
# peertube.social
|
||||
|
||||
This repo lets you easily setup a Peertube server based on docker-compose.
|
||||
This repo contains the Ansible playbook and configuration used on [peertube.social](https://peertube.social).
|
||||
|
||||
There is also a migration script to migrate from the
|
||||
[default Peertube setup](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md)
|
||||
to this setup. Use it at your own risk, and make sure to test and backup
|
||||
before doing this migration.
|
||||
## Usage
|
||||
|
||||
This project is based on the
|
||||
[Peertube docker-compose example](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md).
|
||||
|
||||
You can contact me on the Fediverse about this project:
|
||||
[@felix@radical.town](https://radical.town/@felix).
|
||||
|
||||
## Features
|
||||
|
||||
- easy, automatic setup
|
||||
- integrated Let's Encrypt certificate handling
|
||||
- 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 on your local machine:
|
||||
|
||||
apt install python2-pip
|
||||
pip2 install ansible
|
||||
|
||||
Run the playbook:
|
||||
|
||||
ansible-playbook --become peertube.yml
|
||||
|
||||
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.
|
||||
Just run the following command:
|
||||
```
|
||||
ansible-playbook peertube.yml --ask-vault-pass
|
||||
```
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
---
|
||||
- hosts: all
|
||||
become: yes
|
||||
|
||||
# Install python if required
|
||||
# https://www.josharcher.uk/code/ansible-python-connection-failure-ubuntu-server-1604/
|
||||
|
|
Loading…
Reference in a new issue