README.txt

   1
   2 THIS IS CURRENTLY AN EXPERIMENTAL BUILD.
   3 IF YOU USE IT IN PRODUCTION, DO NOT EXPECT SUPPORT.
   4
   5 Copyright (c) 2019-2021 by Art Cancro
   6
   7 This program is open source software, distributed under the
   8 terms of the GNU General Public License, version 3.  It runs
   9 on the Linux operating system, which uses the Linux kernel.
  10
  11 This repository contains the elements to build a Docker container for
  12 the Citadel system.  We hope that this will eventually become a mainstream
  13 distribution method for the software, replacing the problematic packages
  14 that continue falling out of date in individual Linux/Linux distributions.
  15
  16 To build the container image, simply run the following command from this
  17 directory:
  18
  19 docker build -t citadel .
  20
  21 The resulting image can be run as a standalone container.  It will expose
  22 ports for all of the services provided by Citadel Server, and two instances
  23 of WebCit (HTTP and HTTPS).
  24
  25 Use the "run-citadel.sh" script to start the container, or use it to learn
  26 what information needs to be supplied.  In particular, you need to map a
  27 persistent volume to the data directory, otherwise you will lose all of your
  28 data when the container is upgraded.
  29