From 0d0991a3b1acc447b57c0751d8029b5eb3554063 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20P=C3=A9ters?= Date: Wed, 12 Jun 2013 14:22:17 +0200 Subject: [PATCH] doc: add a README file --- README | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..e5d27d0 --- /dev/null +++ b/README @@ -0,0 +1,48 @@ +wcsinst +======= + +wcsinst is a web application to deploy w.c.s. instances; it is released under +the GNU AGPL Licence. + + +Architecture +------------ + +This project is composed of two Django applications; wcsinst provides a model +and is expected to be installed as part of an administrative portal; wcsinstd +provides the web API to deploy w.c.s. instances and should be installed on its +own, on the host instances should be deployed. + + +Configuration +------------- + +If the WCSINSTD_URL environment variable is set, ./manage.py will run itself as +a standalone wcsinst (admin) site. Go to /admin/. + +Example: WCSINSTD_URL=http://127.0.0.1:8001/ ./manage.py runserver + +The wcsinstd application expects a WCSINST_WCS_APP_DIR setting, that should +point to the w.c.s. application directory (typically /var/lib/wcs/). + +Additionally it expects site skeletons to be made available from the +media/skeletons directory; the default skeleton should go in a subdirectory +named "default". + +A skeleton directory has the following files: + + - export.wcs: as produced from wcs, admin/export + - idff-metadata-template: template file for ID-FF 1.2 metadata (optional) + - saml2-metadata-template: template file for SAMLv2 metadata (optional) + - private-key.pem & public-key.pem: pair of keys for ID-FF/SAML (optional) + - idp-metadata.xml: metadata of the identity provider (optional) + - site-options.cfg: template file for the w.c.s. site-options.cfg file + - apache-vhost.conf: tempalte file for the Apache virtual host configuration + +The template files contains template strings (cf the Python documentation); +there is a single variable made available, named domain (hence ${domain} to +use it). + +The wcsinstd application should be able to run "sudo -n /etc/init.d/apache2 +reload", to reload virtual hosts configuration. Virtual host configuration +files are created in $media/vhosts.d