Merge branch 'release/2.1.0' into develop

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

diff --git a/support/doc/docker.md b/support/doc/docker.md
index 093d7124edbd3782276bf53517f5159332051921..b251329d0130deec31a583edfab2cb74aececfca 100644 (file)
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -6,56 +6,87 @@ You can quickly get a server running using Docker. You need to have
 
 ## Production
 
-### Build your own Docker image
+### Install
 
-```bash
-$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
-$ cd /tmp/peertube
-$ docker build . -f ./support/docker/production/Dockerfile.stretch
-```
-
-### Run a preconfigured setup with all dependencies
+**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
 
 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
-$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
-$ cd /tmp/peertube
+```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
+```
+View the source of the files you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/docker-compose.yml) and the [traefik.toml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/traefik.toml) and the [.env](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env)
+
+Update the reverse proxy configuration:
+
+```shell
+$ vim ./docker-volume/traefik/traefik.toml
 ```
 
-Then tweak the `docker-compose.yml` file there according to your needs. Then
-you can use the regular `up` command to set it up, with possible overrides of
-the environment variables:
+Tweak the `docker-compose.yml` file there according to your needs:
 
-```bash
-$ PEERTUBE_HOSTNAME=peertube.lvh.me \
-  PEERTUBE_ADMIN_EMAIL=test@example.com \
-  PEERTUBE_TRANSCODING_ENABLED=true \
-  PEERTUBE_SIGNUP_ENABLED=true \
-  PEERTUBE_SMTP_HOST=mail.lvh.me \
-  PEERTUBE_SMTP_PORT=1025 \
-  PEERTUBE_SMTP_FROM=noreply@peertube.lvh.me \
-    docker-compose -f support/docker/production/docker-compose.yml --project-directory . up
+```shell
+$ vim ./docker-compose.yml
 ```
 
+Then tweak the `.env` file to change the environment variables:
+
+```shell
+$ vim ./.env
+```
+If you did not download the .env file above, here you can look at the variables that can be set:
+https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env
+
 Other environment variables are used in
 `support/docker/production/config/custom-environment-variables.yaml` and can be
 intuited from usage.
 
-For this example configuration, a reverse proxy is quite recommended. The
-example Docker Compose file provides example labels for a Traefik load
-balancer, although any HTTP reverse proxy will work fine. See the example
-Nginx configuration `support/nginx/peertube` file to get an idea of
-recommendations and requirements to run PeerTube the most efficiently.
+You can use the regular `up` command to set it up:
+
+```shell
+$ docker-compose up
+```
+### Obtaining Your Automatically Generated Admin Credentials
+Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password.
+You're going to want to run `docker-compose logs peertube | grep -A1 root` to search the log output for your new PeerTube's instance admin credentials which will look something like this.
+```BASH
+user@s:~/peertube|master⚡ ⇒  docker-compose logs peertube | grep -A1 root
 
-**Important**: note that you'll get the initial `root` user password from the
-program output, so check out your logs to find them.
+peertube_1  | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
+peertube_1  | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
+```
+
+### 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.buster
+```
 
 ## Development
 
-The Docker image that's preconfigured in `support/docker/dev` contains all the
-services embedded in one image, so as to work correctly on
-[Janitor](https://janitor.technology). It is much not advised to use it in
-production.
+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!