support/doc/docker.md

   1 # Docker guide
   2
   3 You can quickly get a server running using Docker. You need to have
   4 [docker](https://www.docker.com/community-edition) and
   5 [docker-compose](https://docs.docker.com/compose/install/) installed.
   6
   7 ## Production
   8
   9 ### Install
  10
  11 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
  12
  13 PeerTube needs a PostgreSQL and a Redis instance to work correctly. If you want
  14 to quickly set up a full environment, either for trying the service or in
  15 production, you can use a `docker-compose` setup.
  16
  17 #### Go to your peertube workdir
  18 ```shell
  19 cd /your/peertube/directory
  20 ```
  21
  22 #### Create the reverse proxy configuration directory
  23
  24 ```shell
  25 mkdir -p ./docker-volume/traefik
  26 ```
  27
  28 #### Get the latest reverse proxy configuration
  29
  30 ```shell
  31 curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml > ./docker-volume/traefik/traefik.toml
  32 ```
  33
  34 View the source of the file you're about to download: [traefik.toml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/traefik.toml)
  35
  36 #### Create Let's Encrypt ACME certificates as JSON file
  37
  38 ```shell
  39 touch ./docker-volume/traefik/acme.json
  40 ```
  41 Needs to have file mode 600:
  42 ```shell
  43 chmod 600 ./docker-volume/traefik/acme.json
  44 ```
  45
  46 #### Get the latest Compose file
  47
  48 ```shell
  49 curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml
  50 ```
  51
  52 View the source of the file you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/docker-compose.yml)
  53
  54
  55 #### Get the latest env_file
  56
  57 ```shell
  58 curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env
  59 ```
  60
  61 View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env)
  62
  63 #### Update the reverse proxy configuration
  64
  65 ```shell
  66 vim ./docker-volume/traefik/traefik.toml
  67 ```
  68
  69 ~~You must replace `<MY EMAIL ADDRESS>` and `<MY DOMAIN>` to enable Let's Encrypt SSL Certificates creation.~~ Now included in `.env` file with `TRAEFIK_ACME_EMAIL` and `TRAEFIK_ACME_DOMAINS` variables used through traefik service command value of `docker-compose.yml` file.
  70
  71 More at: https://docs.traefik.io/v1.7
  72
  73 #### Tweak the `docker-compose.yml` file there according to your needs
  74
  75 ```shell
  76 vim ./docker-compose.yml
  77 ```
  78
  79 #### Then tweak the `.env` file to change the environment variables
  80
  81 ```shell
  82 vim ./.env
  83 ```
  84 In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace:
  85 - `<MY POSTGRES USERNAME>`
  86 - `<MY POSTGRES PASSWORD>`
  87 - `<MY DOMAIN>` without 'https://'
  88 - `<MY EMAIL ADDRESS>`
  89
  90 Other environment variables are used in
  91 [/support/docker/production/config/custom-environment-variables.yaml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/custom-environment-variables.yaml) and can be
  92 intuited from usage.
  93
  94 #### Testing local Docker setup
  95
  96 To test locally your Docker setup, you must add your domain (`<MY DOMAIN>`) in `/etc/hosts`:
  97 ```
  98 127.0.0.1       localhost   mydomain.tld
  99 ```
 100
 101 #### You can use the regular `up` command to set it up
 102
 103 ```shell
 104 docker-compose up
 105 ```
 106 ### Obtaining Your Automatically Generated Admin Credentials
 107 Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password.
 108 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.
 109 ```BASH
 110 user@s:~/peertube|master⚡ ⇒  docker-compose logs peertube | grep -A1 root
 111
 112 peertube_1  | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
 113 peertube_1  | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
 114 ```
 115
 116 ### Obtaining Your Automatically Generated DKIM DNS TXT Record
 117 [DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail) signature sending and RSA keys generation are enabled by the default Postfix image `mwader/postfix-relay` with [OpenDKIM](http://www.opendkim.org/).
 118 Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain :
 119 ```BASH
 120 user@s:~/peertube|master⚡ ⇒  cat ./docker-volume/opendkim/keys/*/*.txt
 121
 122 peertube._domainkey.mydomain.tld.       IN      TXT     ( "v=DKIM1; h=sha256; k=rsa; "
 123           "p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n"
 124           "j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" )  ; ----- DKIM key peertube for mydomain.tld
 125 ```
 126
 127 ### Administrator password
 128
 129 See the production guide ["Administrator" section](https://docs.joinpeertube.org/#/install-any-os?id=administrator)
 130
 131 ### What now?
 132
 133 See the production guide ["What now" section](https://docs.joinpeertube.org/#/install-any-os?id=what-now).
 134
 135 ### Upgrade
 136
 137 **Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/production.yaml).
 138
 139 Pull the latest images and rerun PeerTube:
 140
 141 ```shell
 142 $ cd /your/peertube/directory
 143 $ docker-compose pull
 144 $ docker-compose up -d
 145 ```
 146
 147 ## Build your own Docker image
 148
 149 ```shell
 150 $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
 151 $ cd /tmp/peertube
 152 $ docker build . -f ./support/docker/production/Dockerfile.buster
 153 ```
 154
 155 ## Development
 156
 157 We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md#develop)
 158 for more information on how you can hack PeerTube!