2018-01-29 05:23:38 -05:00
# Docker guide
2018-03-15 09:39:04 -04:00
You can quickly get a server running using Docker. You need to have
[docker ](https://www.docker.com/community-edition ) and
[docker-compose ](https://docs.docker.com/compose/install/ ) installed.
2018-01-29 05:23:38 -05:00
2018-03-15 09:39:04 -04:00
## Production
2018-05-28 04:53:57 -04:00
### Install
2018-01-29 05:23:38 -05:00
2018-06-28 09:25:39 -04:00
**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
2018-03-15 09:39:04 -04:00
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.
2018-01-29 05:23:38 -05:00
2018-06-02 02:36:49 -04:00
```shell
2018-05-28 04:53:57 -04:00
$ 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
2018-06-02 02:36:49 -04:00
$ 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
2018-05-28 04:53:57 -04:00
```
Update the reverse proxy configuration:
2018-06-02 02:36:49 -04:00
```shell
2018-05-28 04:53:57 -04:00
$ vim ./docker-volume/traefik/traefik.toml
```
Tweak the `docker-compose.yml` file there according to your needs:
2018-01-29 05:23:38 -05:00
2018-06-02 02:36:49 -04:00
```shell
2018-06-27 18:13:14 -04:00
$ vim ./docker-compose.yml
2018-05-28 04:53:57 -04:00
```
2018-06-02 02:36:49 -04:00
Then tweak the `.env` file to change the enviromnent variables:
2018-01-29 05:23:38 -05:00
2018-06-02 02:36:49 -04:00
```shell
$ vim ./.env
2018-03-15 09:39:04 -04:00
```
Other environment variables are used in
`support/docker/production/config/custom-environment-variables.yaml` and can be
intuited from usage.
2018-06-02 02:36:49 -04:00
You can use the regular `up` command to set it up:
```shell
$ docker-compose up
```
2018-03-15 09:39:04 -04:00
**Important**: note that you'll get the initial `root` user password from the
program output, so check out your logs to find them.
2018-07-19 10:17:54 -04:00
### What now?
See the production guide ["What now" section ](/support/doc/production.md#what-now ).
2018-05-28 04:53:57 -04:00
### Upgrade
2019-02-21 09:05:44 -05:00
**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file ](/support/docker/production/config/production.yaml ).
2018-05-28 04:53:57 -04:00
Pull the latest images and rerun PeerTube:
2018-06-02 02:36:49 -04:00
```shell
2018-05-28 05:39:09 -04:00
$ cd /your/peertube/directory
2018-05-28 04:53:57 -04:00
$ docker-compose pull
2018-06-02 02:36:49 -04:00
$ docker-compose up -d
2018-05-28 04:53:57 -04:00
```
## Build your own Docker image
2018-06-02 02:36:49 -04:00
```shell
2018-05-28 04:53:57 -04:00
$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
$ cd /tmp/peertube
$ docker build . -f ./support/docker/production/Dockerfile.stretch
```
2018-03-15 09:39:04 -04:00
## Development
2018-01-29 05:23:38 -05:00
2018-05-28 04:53:57 -04:00
We don't have a Docker image for development. See [the CONTRIBUTING guide ](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop )
2018-06-02 02:36:49 -04:00
for more information on how you can hack PeerTube!