From 75cb31b3bc8d0cf9c0907aa1f7e35113318632b5 Mon Sep 17 00:00:00 2001 From: Josh Schertz Date: Wed, 25 Mar 2020 15:01:21 -0400 Subject: [PATCH] doc: add build instructions to README --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 78db635..dd17a57 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ This repository contains the necessary tools to run a Jitsi Meet stack on [Docke * [Configurations](#configuration) - [Advanced configuration](#advanced-configuration) - [Running on a LAN environment](#running-on-a-lan-environment) -* [Limitations](#limitations) +* [Build Instructions](#build-instructions) +* [ToDo](#todo)
@@ -430,6 +431,16 @@ succeed. If your users are coming in over the Internet (and not over LAN), this The public IP address is discovered via [STUN]. STUN servers can be specified with the ``JVB_STUN_SERVERS`` option. +## Build Instructions + +Building your own images allows you to edit the configuration files of each image individually, providing more customization for your deployment. + +The docker images can be built by running the `make` command in the main repository folder. If you need to overwrite existing images from the remote source, use `FORCE_REBUILD=1 make`. + +If you are on the unstable branch, build the images with `FORCE_REBUILD=1 JITSI_RELEASE=unstable make`. + +You are now able to run `docker-compose up` as usual. + ## TODO * Support container replicas (where applicable).