From b44a96300c1f82e24cfc296de821d809bf031f38 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 28 May 2018 10:53:57 +0200 Subject: Improve docker doc and fix missing keys on update --- support/doc/docker.md | 71 +++++++++++++++++++++++++++++---------------------- 1 file changed, 40 insertions(+), 31 deletions(-) (limited to 'support/doc/docker.md') diff --git a/support/doc/docker.md b/support/doc/docker.md index ae2b0f9c0..410db1136 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -6,56 +6,65 @@ You can quickly get a server running using Docker. You need to have ## Production -### Build your own Docker image - -```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 +### Install 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 +$ 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 +``` + +Update the reverse proxy configuration: + ``` +$ vim ./docker-volume/traefik/traefik.toml +``` + +Tweak the `docker-compose.yml` file there according to your needs: -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 +``` +$ vim ./docker-compose.yaml +``` + +You can use the regular `up` command to set it up, with possible overrides of the environment variables: ```bash -$ PEERTUBE_WEBSERVER_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 +$ PEERTUBE_WEBSERVER_HOSTNAME="domain.tld" docker-compose up ``` 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. - **Important**: note that you'll get the initial `root` user password from the program output, so check out your logs to find them. +### Upgrade + +Pull the latest images and rerun PeerTube: + +``` +$ docker-compose pull +$ PEERTUBE_WEBSERVER_HOSTNAME="domain.tld" docker-compose up +``` + + +## Build your own Docker image + +```bash +$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube +$ cd /tmp/peertube +$ docker build . -f ./support/docker/production/Dockerfile.stretch +``` + ## 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! \ No newline at end of file -- cgit v1.2.3