aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4d9cc298f..202d6680d 100644
--- a/README.md
+++ b/README.md
@@ -65,8 +65,8 @@ donating to them](https://soutenir.framasoft.org/en/).**
65Want to see it in action? 65Want to see it in action?
66 66
67 * Demonstration servers: 67 * Demonstration servers:
68 * [peertube.cpy.re](http://peertube.cpy.re) 68 * [peertube.cpy.re](http://peertube.cpy.re)
69 * [peertube2.cpy.re](http://peertube2.cpy.re) 69 * [peertube2.cpy.re](http://peertube2.cpy.re)
70 * [peertube3.cpy.re](http://peertube3.cpy.re) 70 * [peertube3.cpy.re](http://peertube3.cpy.re)
71 * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) 71 * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
72 to see what the "decentralization feature" looks like 72 to see what the "decentralization feature" looks like
@@ -139,6 +139,26 @@ BitTorrent) inside the web browser, as of today.
139 * OpenSSL (cli) 139 * OpenSSL (cli)
140 * FFmpeg 140 * FFmpeg
141 141
142## Run using Docker
143
144You 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.
145
146For this example configuration, you should also run a reverse proxy. The example
147Docker Compose file provides example labels for the Traefik load balancer,
148though any HTTP reverse proxy is compatible.
149
150Example for running a peertube server locally:
151
152```bash
153sudo \
154 PEERTUBE_HOSTNAME=peertube.lvh.me \
155 PEERTUBE_ADMIN_EMAIL=test@example.com \
156 PEERTUBE_TRANSCODING_ENABLED=true \
157 docker-compose up app
158```
159
160(Get the initial root user password from the program output.)
161
142## Production 162## Production
143 163
144See the [production guide](support/doc/production.md). 164See the [production guide](support/doc/production.md).