X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdocker.md;h=d7059d285b5aee0235fc39cd81b5d2e8e588752e;hb=7cd1b12c19d0589d1d692ed0571ca0800f028aea;hp=7f331182702e28ea1e932e9bf9bcce96fd9314f9;hpb=9007daff8262bcb539eb5fa74919828f425b5f69;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index 7f3311827..d7059d285 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -8,65 +8,86 @@ You can quickly get a server running using Docker. You need to have ### Install +**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 +```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" > ./docker-compose.yml +$ 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 ``` Tweak the `docker-compose.yml` file there according to your needs: -``` -$ vim ./docker-compose.yaml +```shell +$ vim ./docker-compose.yml ``` -You can use the regular `up` command to set it up, with possible overrides of -the environment variables: +Then tweak the `.env` file to change the environment variables: -```bash -$ PEERTUBE_WEBSERVER_HOSTNAME="domain.tld" docker-compose up +```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. -**Important**: note that you'll get the initial `root` user password from the -program output, so check out your logs to find them. +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 + +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 down $ docker-compose pull -$ PEERTUBE_WEBSERVER_HOSTNAME="domain.tld" docker-compose up -d +$ docker-compose up -d ``` - ## Build your own Docker image -```bash +```shell $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube $ cd /tmp/peertube -$ docker build . -f ./support/docker/production/Dockerfile.stretch +$ docker build . -f ./support/docker/production/Dockerfile.buster ``` ## Development 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! \ No newline at end of file +for more information on how you can hack PeerTube!