Application to deploy wcs instances
This repository has been archived on 2023-02-21. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Benjamin Dauvergne 66e3d79fcd wcsinstd: pass the received site_options_cfg record to the site-options.cfg template file
refs #3193
2013-09-02 10:44:36 +02:00
wcsinst wcsinstd: pass the received site_options_cfg record to the site-options.cfg template file 2013-09-02 10:44:36 +02:00
.gitignore add .gitignore 2013-09-02 10:44:21 +02:00
README doc: add a README file 2013-06-12 14:22:17 +02:00
manage.py Basic functionalities 2013-06-12 11:57:51 +02:00
requirements.txt initialize south migrations 2013-09-02 10:44:21 +02:00
setup.py project start 2013-06-12 11:56:55 +02:00

README

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