diff options
author | Chocobozzz <me@florianbigard.com> | 2018-01-29 11:23:38 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-01-29 11:23:38 +0100 |
commit | 4df6a1b8e1ec98355667cb872511d27035bfaf5a (patch) | |
tree | 5fc9c52b2f65f7de3844c8c9599aa9d9fb51ad5c | |
parent | 2fe8692797ec8da890a6f954e6c850abc0dbf7e4 (diff) | |
download | PeerTube-4df6a1b8e1ec98355667cb872511d27035bfaf5a.tar.gz PeerTube-4df6a1b8e1ec98355667cb872511d27035bfaf5a.tar.zst PeerTube-4df6a1b8e1ec98355667cb872511d27035bfaf5a.zip |
Move docker do in support/doc
-rw-r--r-- | README.md | 20 | ||||
-rw-r--r-- | support/doc/docker.md | 25 | ||||
-rw-r--r-- | support/doc/production.md | 21 |
3 files changed, 30 insertions, 36 deletions
@@ -141,27 +141,11 @@ BitTorrent) inside the web browser, as of today. | |||
141 | 141 | ||
142 | ## Run using Docker | 142 | ## Run using Docker |
143 | 143 | ||
144 | 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. | 144 | See the [docker guide](/support/doc/docker.md) |
145 | |||
146 | For this example configuration, you should also run a reverse proxy. The example | ||
147 | Docker Compose file provides example labels for the Traefik load balancer, | ||
148 | though any HTTP reverse proxy is compatible. | ||
149 | |||
150 | Example for running a peertube server locally: | ||
151 | |||
152 | ```bash | ||
153 | sudo \ | ||
154 | PEERTUBE_HOSTNAME=peertube.lvh.me \ | ||
155 | PEERTUBE_ADMIN_EMAIL=test@example.com \ | ||
156 | PEERTUBE_TRANSCODING_ENABLED=true \ | ||
157 | docker-compose up app | ||
158 | ``` | ||
159 | |||
160 | (Get the initial root user password from the program output.) | ||
161 | 145 | ||
162 | ## Production | 146 | ## Production |
163 | 147 | ||
164 | See the [production guide](support/doc/production.md). | 148 | See the [production guide](/support/doc/production.md). |
165 | 149 | ||
166 | ## Contributing | 150 | ## Contributing |
167 | 151 | ||
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 | |||
5 | 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. | ||
6 | |||
7 | For this example configuration, you should also run a reverse proxy. The example | ||
8 | Docker Compose file provides example labels for the Traefik load balancer, | ||
9 | though any HTTP reverse proxy is compatible. | ||
10 | |||
11 | Example for running a peertube server locally: | ||
12 | |||
13 | ```bash | ||
14 | sudo \ | ||
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 | |||
25 | 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 @@ | |||
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 | |||
321 | There 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 | |||
325 | 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. | ||
326 | |||
327 | 2. 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 | |||
331 | 2. Have a look at the file and adjust the variables to your need. | ||
332 | |||
333 | 3. Deploy the stack: | ||
334 | |||
335 | docker stack deploy -c peertube.yml peertube | ||