aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorkaiyou <pierre@jaury.eu>2018-01-29 08:52:20 +0100
committerChocobozzz <me@florianbigard.com>2018-01-29 08:52:20 +0100
commite8395f027b6c3e3f757c740e35b20e76c51b03bd (patch)
treeee0e761357b7407b6992600342306669de880689 /README.md
parent8dfd8fd7ca376e7898c912bb985a7a4a997cd966 (diff)
downloadPeerTube-e8395f027b6c3e3f757c740e35b20e76c51b03bd.tar.gz
PeerTube-e8395f027b6c3e3f757c740e35b20e76c51b03bd.tar.zst
PeerTube-e8395f027b6c3e3f757c740e35b20e76c51b03bd.zip
Add production Alpine and Debian Stretch Docker images (#225)
* First pass at a (swarm-compatible) docker image Uses an existing traefik server as a https reverse proxy. * Add example config for a Docker swarm deployment * Point to traefik config for docker compose setup * Clarify that traefik is needed for the example config * Use node:8-stretch base image and don't install yarn (The base image already contains yarn.) * Initial commit for an Alpine Docker image * Fix docker volume path * Merge #213 and #225 and move files around * Remove unnecessary dependencies from the alpine build * Update Dockerfiles to match install path, config path, etc. * Update the configuration in the example compose file * Update the configuration in the example swarm file * Remove the declared networks and volumes from the compose example, which are not strictly required * Update attachment path in the documentation * Display traefik as a suggestion and not a required dependency * Update the Docker ignored files * Fix typos reported in #225 * Move production Dockerfiles to a production directory * Add the redis configuration settings * Add Docker files to the dockerignore * Make the signup limit configurable
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).