Updated docs

[citadel-docker.git] / README.txt

diff --git a/README.txt b/README.txt
index 89ac695ee38fd3119de8151b7a87a78c4051863c..e98e016d030b7244a964435d2a590462f0e8f373 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -8,10 +8,15 @@ This program is open source software, distributed under the
 terms of the GNU General Public License, version 3.  It runs
 on the Linux operating system, which uses the Linux kernel.
 
-This repository contains the elements to build a Docker container for
-the Citadel system.  We hope that this will eventually become a mainstream
-distribution method for the software, replacing the problematic packages
-that continue falling out of date in individual Linux/Linux distributions.
+This builds a container that hosts the entire Citadel system, including the Citadel Server,
+along with WebCit and all supporting libraries.  We are containerizing it to make it easy
+to deploy, not to turn it into a microservice, so please don't bother with the comments about
+containerizing a monolithic application.
+
+The container exposes a multitude of ports and expects a persistent volume to be mounted
+to /citadel-data , where the database, TLS key/certificate, and any uploaded files will be
+stored.  It also accepts a build variable `branch` which can be set to any valid branch or
+tag in the git repository from which to build the container.
 
 To build the container image, simply run the following command from this
 directory: