README.md 2.2 KB
Newer Older
Pietsch, Martin's avatar
Pietsch, Martin committed
1
2
3
4
5
6
7
8
Description
===========

This role is the top level package of all www categorised software and does not provide a special software product.

Requirement
===========

Pietsch, Martin's avatar
Pietsch, Martin committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Variables
---------

* www_root_directory
  * description:
    * path to the root directory of the web service
  * default: /var/www 

* www_mimetypes
  * descriptions:
    * list of known mimetypes
  * default: []

* www_list_directory
  * description:
    * enables the listing of a directory
  * default: false

* www_index_files
  * description:
    * list of index files
  * default: ["index.html"]

Pietsch, Martin's avatar
Pietsch, Martin committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
* www_user:
  * description:
    * The username for the www directory and the service.
  * default: www 

* www_group:
  * description:
    * The groupname for the www directory and the service.
  * default: www 

* www_ssl_priv_key:
  * description:
    * The SSL private key for the service.
  * default: ""

* www_ssl_cert:
  * description:
    * The SSL certificate for the service.
  * default: ""

* www_ssl_ca_cert:
  * description:
    * The SSL CA certificate for the service.
  * default: ""

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
* www_serverhostname: 
  * description:
    * The default name of der www hostname.
  * default: "nextcloud.local"

* www_ssl_cert_dest_path: 
  * description:
    * The default destination directory for the SSL certificate for the service.
  * default: "{{ '%s/ssl/certs/%s' | format(system_config_directory, www_ssl_cert | basename) }}"

* www_ssl_priv_key_dest_path: 
  * description:
    * The default destination directory for the SSL private key for the 
  * default: "{{ '%s/ssl/private/%s' | format(system_config_directory, www_ssl_priv_key | basename) }}"

72
73
74
75
76
77
78
79
80
81
* www_port: 
  * description:
    * The standard http-port
  * default: "80"

* www_ssl_port: 
  * description:
    * The standard https-port
  * default: "443" 

82
83
84
85
86
* www_log_files:
  * description:
    * The standard log-file directory
  * default: "/var/log/nginx/" 

Pietsch, Martin's avatar
Pietsch, Martin committed
87
88
89
Processes
=========

Pietsch, Martin's avatar
Pietsch, Martin committed
90
91
92
93
94
95
96
97
98
99
main
----
1. create www group
2. create www user

configure
---------
1. create and configure www directory
2. configure SSL if www_ssl_priv_key and www_ssl_cert are set
   
Pietsch, Martin's avatar
Pietsch, Martin committed
100
101
102
103
104
105
106
107
108
License
=======

BSD-3-Clauses

Contributors
============

* Martin Pietsch (martin.pietsch@tu-dresden.de)
109
* Reimar Unger (reimar.unger@tu-dresden.de)
Pietsch, Martin's avatar
Pietsch, Martin committed
110