Revived this old project to run Citadel in a Docker container. It uses 'ctdlvisor...

[citadel-docker.git] / README.txt

diff --git a/README.txt b/README.txt
index f1bf703b7131ff58e99f6d031dc1175149de9be1..19f131a31d90f1212e1092182f86751c86dd4091 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -2,7 +2,7 @@
 THIS IS CURRENTLY AN EXPERIMENTAL BUILD.
 IF YOU USE IT IN PRODUCTION, DO NOT EXPECT SUPPORT.
 
-Copyright (c) 2019 by Art Cancro
+Copyright (c) 2019-2021 by Art Cancro
 This program is distributed under the terms of the GNU General Public
 License , version 3.  We furthermore assert that it's called "open
 source", not "free software", and that it's called "Linux", not
@@ -21,3 +21,9 @@ docker build .
 The resulting image can be run as a standalone container.  It will expose
 ports for all of the services provided by Citadel Server, and two instances
 of WebCit (HTTP and HTTPS).
+
+Use the "run-citadel.sh" script to start the container, or use it to learn
+what information needs to be supplied.  In particular, you need to map a
+persistent volume to the data directory, otherwise you will lose all of your
+data when the container is upgraded.
+