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.
11 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
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.
17 #### Go to your peertube workdir
19 cd /your/peertube/directory
22 #### Create the reverse proxy configuration directory
25 mkdir -p ./docker-volume/traefik
28 #### Get the latest reverse proxy configuration
31 curl https://raw.github.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml > ./docker-volume/traefik/traefik.toml
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)
36 #### Create Let's Encrypt ACME certificates as JSON file
39 touch ./docker-volume/traefik/acme.json
41 Needs to have file mode 600:
43 chmod 600 ./docker-volume/traefik/acme.json
46 #### Get the latest Compose file
49 curl https://raw.github.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml
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)
55 #### Get the latest env_file
58 curl https://raw.github.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env
61 View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env)
63 #### Update the reverse proxy configuration
66 vim ./docker-volume/traefik/traefik.toml
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.
71 More at: https://docs.traefik.io/v1.7
73 #### Tweak the `docker-compose.yml` file there according to your needs
76 vim ./docker-compose.yml
79 #### Then tweak the `.env` file to change the environment variables
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>`
88 - `<MY DOMAIN>` without 'https://'
89 - `<MY EMAIL ADDRESS>`
91 Other environment variables are used in
92 [/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
95 #### Testing local Docker setup
97 To test locally your Docker setup, you must add your domain (`<MY DOMAIN>`) in `/etc/hosts`:
99 127.0.0.1 localhost mydomain.tld
102 #### You can use the regular `up` command to set it up
107 ### Obtaining Your Automatically Generated Admin Credentials
108 Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password.
109 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.
111 user@s:~/peertube|master⚡ ⇒ docker-compose logs peertube | grep -A1 root
113 peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
114 peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
119 See the production guide ["What now" section](/support/doc/production.md#what-now).
123 **Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](/support/docker/production/config/production.yaml).
125 Pull the latest images and rerun PeerTube:
128 $ cd /your/peertube/directory
129 $ docker-compose pull
130 $ docker-compose up -d
133 ## Build your own Docker image
136 $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
138 $ docker build . -f ./support/docker/production/Dockerfile.buster
143 We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md#develop)
144 for more information on how you can hack PeerTube!