Bumped to version v1.4.1

[github/Chocobozzz/PeerTube.git] / support / doc / docker.md

diff --git a/support/doc/docker.md b/support/doc/docker.md
index 8ae77902fd5f16626d826d944ad32050e8593fc0..7b2d867a0dd8cd088dc969647c2610de6e21f6f3 100644 (file)
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -1,25 +1,83 @@
 # 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.
 
-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.
+## Production
+
+### Install
 
-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.
+**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
 
-Example for running a peertube server locally:
+PeerTube needs a PostgreSQL and a Redis instance to work correctly. If you want
+to quickly set up a full environment, either for trying the service or in
+production, you can use a `docker-compose` setup.
 
-```bash
-sudo \
-  PEERTUBE_HOSTNAME=peertube.lvh.me \
-  PEERTUBE_ADMIN_EMAIL=test@example.com \
-  PEERTUBE_TRANSCODING_ENABLED=true \
-  docker-compose up app
+```shell
+$ cd /your/peertube/directory
+$ mkdir ./docker-volume && mkdir ./docker-volume/traefik
+$ curl "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml" > ./docker-volume/traefik/traefik.toml
+$ touch ./docker-volume/traefik/acme.json && chmod 600 ./docker-volume/traefik/acme.json
+$ curl -s "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml" -o docker-compose.yml "https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env" -o .env
 ```
 
-(Get the initial root user password from the program output.)
+Update the reverse proxy configuration:
 
-## Production
+```shell
+$ vim ./docker-volume/traefik/traefik.toml
+```
+
+Tweak the `docker-compose.yml` file there according to your needs:
+
+```shell
+$ vim ./docker-compose.yml
+```
+
+Then tweak the `.env` file to change the enviromnent variables:
+
+```shell
+$ vim ./.env
+```
+
+Other environment variables are used in
+`support/docker/production/config/custom-environment-variables.yaml` and can be
+intuited from usage.
+
+You can use the regular `up` command to set it up:
+
+```shell
+$ docker-compose up
+```
+
+**Important**: note that you'll get the initial `root` user password from the
+program output, so check out your logs to find them.
+
+### What now?
+
+See the production guide ["What now" section](/support/doc/production.md#what-now). 
+
+### Upgrade
+
+**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](/support/docker/production/config/production.yaml). 
+
+Pull the latest images and rerun PeerTube:
+
+```shell
+$ cd /your/peertube/directory
+$ docker-compose pull
+$ docker-compose up -d
+```
+
+## Build your own Docker image
+
+```shell
+$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
+$ cd /tmp/peertube
+$ docker build . -f ./support/docker/production/Dockerfile.stretch
+```
+
+## Development
 
-PR welcome!
+We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop)
+for more information on how you can hack PeerTube!