aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/docker.md
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc/docker.md')
-rw-r--r--support/doc/docker.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/support/doc/docker.md b/support/doc/docker.md
new file mode 100644
index 000000000..8ae77902f
--- /dev/null
+++ b/support/doc/docker.md
@@ -0,0 +1,25 @@
1# Docker guide
2
3## Test/Development
4
5You 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.
6
7For this example configuration, you should also run a reverse proxy. The example
8Docker Compose file provides example labels for the Traefik load balancer,
9though any HTTP reverse proxy is compatible.
10
11Example for running a peertube server locally:
12
13```bash
14sudo \
15 PEERTUBE_HOSTNAME=peertube.lvh.me \
16 PEERTUBE_ADMIN_EMAIL=test@example.com \
17 PEERTUBE_TRANSCODING_ENABLED=true \
18 docker-compose up app
19```
20
21(Get the initial root user password from the program output.)
22
23## Production
24
25PR welcome!