Add production Alpine and Debian Stretch Docker images (#225)

[github/Chocobozzz/PeerTube.git] / README.md

diff --git a/README.md b/README.md
index 4d9cc298fe7067adc0c081219526cf8d94dd43ca..202d6680de52f714445628c51d48f5cb3fb3e0bb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -65,8 +65,8 @@ donating to them](https://soutenir.framasoft.org/en/).**
 Want to see it in action?
 
    * Demonstration servers:
-     * [peertube.cpy.re](http://peertube.cpy.re) 
-     * [peertube2.cpy.re](http://peertube2.cpy.re) 
+     * [peertube.cpy.re](http://peertube.cpy.re)
+     * [peertube2.cpy.re](http://peertube2.cpy.re)
      * [peertube3.cpy.re](http://peertube3.cpy.re)
    * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
      to see what the "decentralization feature" looks like
@@ -139,6 +139,26 @@ BitTorrent) inside the web browser, as of today.
   * OpenSSL (cli)
   * FFmpeg
 
+## Run using Docker
+
+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.
+
+For this example configuration, you should also run a reverse proxy. The example
+Docker Compose file provides example labels for the Traefik load balancer,
+though any HTTP reverse proxy is compatible.
+
+Example for running a peertube server locally:
+
+```bash
+sudo \
+  PEERTUBE_HOSTNAME=peertube.lvh.me \
+  PEERTUBE_ADMIN_EMAIL=test@example.com \
+  PEERTUBE_TRANSCODING_ENABLED=true \
+  docker-compose up app
+```
+
+(Get the initial root user password from the program output.)
+
 ## Production
 
 See the [production guide](support/doc/production.md).