|
1
|
wcsinst
|
|
2
|
=======
|
|
3
|
|
|
4
|
wcsinst is a web application to deploy w.c.s. instances; it is released under
|
|
5
|
the GNU AGPL Licence.
|
|
6
|
|
|
7
|
|
|
8
|
Architecture
|
|
9
|
------------
|
|
10
|
|
|
11
|
This project is composed of two Django applications; wcsinst provides a model
|
|
12
|
and is expected to be installed as part of an administrative portal; wcsinstd
|
|
13
|
provides the web API to deploy w.c.s. instances and should be installed on its
|
|
14
|
own, on the host instances should be deployed.
|
|
15
|
|
|
16
|
|
|
17
|
Configuration
|
|
18
|
-------------
|
|
19
|
|
|
20
|
If the WCSINSTD_URL environment variable is set, ./manage.py will run itself as
|
|
21
|
a standalone wcsinst (admin) site. Go to /admin/.
|
|
22
|
|
|
23
|
Example: WCSINSTD_URL=http://127.0.0.1:8001/ ./manage.py runserver
|
|
24
|
|
|
25
|
The wcsinstd application expects a WCSINST_WCS_APP_DIR setting, that should
|
|
26
|
point to the w.c.s. application directory (typically /var/lib/wcs/).
|
|
27
|
|
|
28
|
Additionally it expects site skeletons to be made available from the
|
|
29
|
media/skeletons directory; the default skeleton should go in a subdirectory
|
|
30
|
named "default".
|
|
31
|
|
|
32
|
A skeleton directory has the following files:
|
|
33
|
|
|
34
|
- export.wcs: as produced from wcs, admin/export
|
|
35
|
- idff-metadata-template: template file for ID-FF 1.2 metadata (optional)
|
|
36
|
- saml2-metadata-template: template file for SAMLv2 metadata (optional)
|
|
37
|
- private-key.pem & public-key.pem: pair of keys for ID-FF/SAML (optional)
|
|
38
|
- idp-metadata.xml: metadata of the identity provider (optional)
|
|
39
|
- site-options.cfg: template file for the w.c.s. site-options.cfg file
|
|
40
|
- apache-vhost.conf: tempalte file for the Apache virtual host configuration
|
|
41
|
|
|
42
|
The template files contains template strings (cf the Python documentation);
|
|
43
|
there is a single variable made available, named domain (hence ${domain} to
|
|
44
|
use it).
|
|
45
|
|
|
46
|
The wcsinstd application should be able to run "sudo -n /etc/init.d/apache2
|
|
47
|
reload", to reload virtual hosts configuration. Virtual host configuration
|
|
48
|
files are created in $media/vhosts.d
|