aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/docker.md25
-rw-r--r--support/doc/production.md21
2 files changed, 28 insertions, 18 deletions
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 @@
1# Docker guide
2
3## Test/Development
4
5You 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.
6
7For this example configuration, you should also run a reverse proxy. The example
8Docker Compose file provides example labels for the Traefik load balancer,
9though any HTTP reverse proxy is compatible.
10
11Example for running a peertube server locally:
12
13```bash
14sudo \
15 PEERTUBE_HOSTNAME=peertube.lvh.me \
16 PEERTUBE_ADMIN_EMAIL=test@example.com \
17 PEERTUBE_TRANSCODING_ENABLED=true \
18 docker-compose up app
19```
20
21(Get the initial root user password from the program output.)
22
23## Production
24
25PR 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 @@
1# Production guide 1# Production guide
2 2
3 * [Installation](#installation)
4 * [Upgrade](#upgrade)
5
3## Installation 6## Installation
4 7
5### Dependencies 8### Dependencies
@@ -315,21 +318,3 @@ $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19
315 pg_restore -U peertube -c -d peertube_prod "$SQL_BACKUP_PATH" 318 pg_restore -U peertube -c -d peertube_prod "$SQL_BACKUP_PATH"
316 sudo systemctl restart peertube 319 sudo systemctl restart peertube
317``` 320```
318
319## Installation on Docker Swarm
320
321There is an example configuration for deploying peertube and a postgres database as a Docker swarm stack. It works like this:
322
323(_Note_: You need to make sure to set `traefik` and `peertube` labels on the target node(s) for this configuration to work.)
324
3251. Install a traefik loadbalancer stack (including Let's Encrypt) on your docker swarm. [Here](https://gist.github.com/djmaze/2684fbf147d775c8ee441b4302554823) is an example configuration.
326
3272. Copy the [example stack file](support/docker/production/docker-stack.example.yml) for peertube:
328
329 scp support/docker/production/docker-stack.example.yml root@your-server:/path/to/your/swarm-config/peertube.yml
330
3312. Have a look at the file and adjust the variables to your need.
332
3333. Deploy the stack:
334
335 docker stack deploy -c peertube.yml peertube