From 4df6a1b8e1ec98355667cb872511d27035bfaf5a Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 29 Jan 2018 11:23:38 +0100 Subject: [PATCH] Move docker do in support/doc --- README.md | 20 ++------------------ support/doc/docker.md | 25 +++++++++++++++++++++++++ support/doc/production.md | 21 +++------------------ 3 files changed, 30 insertions(+), 36 deletions(-) create mode 100644 support/doc/docker.md diff --git a/README.md b/README.md index 202d6680d..f3a754d54 100644 --- a/README.md +++ b/README.md @@ -141,27 +141,11 @@ BitTorrent) inside the web browser, as of today. ## Run using Docker -You can quickly get a server running using Docker. You need to have [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/install/) installed. - -For this example configuration, you should also run a reverse proxy. The example -Docker Compose file provides example labels for the Traefik load balancer, -though any HTTP reverse proxy is compatible. - -Example for running a peertube server locally: - -```bash -sudo \ - PEERTUBE_HOSTNAME=peertube.lvh.me \ - PEERTUBE_ADMIN_EMAIL=test@example.com \ - PEERTUBE_TRANSCODING_ENABLED=true \ - docker-compose up app -``` - -(Get the initial root user password from the program output.) +See the [docker guide](/support/doc/docker.md) ## Production -See the [production guide](support/doc/production.md). +See the [production guide](/support/doc/production.md). ## Contributing diff --git a/support/doc/docker.md b/support/doc/docker.md new file mode 100644 index 000000000..8ae77902f --- /dev/null +++ b/support/doc/docker.md @@ -0,0 +1,25 @@ +# Docker guide + +## Test/Development + +You can quickly get a server running using Docker. You need to have [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/install/) installed. + +For this example configuration, you should also run a reverse proxy. The example +Docker Compose file provides example labels for the Traefik load balancer, +though any HTTP reverse proxy is compatible. + +Example for running a peertube server locally: + +```bash +sudo \ + PEERTUBE_HOSTNAME=peertube.lvh.me \ + PEERTUBE_ADMIN_EMAIL=test@example.com \ + PEERTUBE_TRANSCODING_ENABLED=true \ + docker-compose up app +``` + +(Get the initial root user password from the program output.) + +## Production + +PR welcome! diff --git a/support/doc/production.md b/support/doc/production.md index ae7f3e0f6..56d00bf56 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -1,5 +1,8 @@ # Production guide + * [Installation](#installation) + * [Upgrade](#upgrade) + ## Installation ### Dependencies @@ -315,21 +318,3 @@ $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19 pg_restore -U peertube -c -d peertube_prod "$SQL_BACKUP_PATH" sudo systemctl restart peertube ``` - -## Installation on Docker Swarm - -There is an example configuration for deploying peertube and a postgres database as a Docker swarm stack. It works like this: - -(_Note_: You need to make sure to set `traefik` and `peertube` labels on the target node(s) for this configuration to work.) - -1. Install a traefik loadbalancer stack (including Let's Encrypt) on your docker swarm. [Here](https://gist.github.com/djmaze/2684fbf147d775c8ee441b4302554823) is an example configuration. - -2. Copy the [example stack file](support/docker/production/docker-stack.example.yml) for peertube: - - scp support/docker/production/docker-stack.example.yml root@your-server:/path/to/your/swarm-config/peertube.yml - -2. Have a look at the file and adjust the variables to your need. - -3. Deploy the stack: - - docker stack deploy -c peertube.yml peertube