author | Denis Laxalde <denis.laxalde@logilab.fr> |
Wed, 29 Mar 2017 13:29:41 +0200 | |
branch | 3.25 |
changeset 12114 | 40446d4e1ee2 |
parent 11913 | 4516c3956d46 |
permissions | -rw-r--r-- |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
1 |
.. -*- coding: utf-8 -*- |
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
2 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
3 |
|
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
4 |
Configure an instance |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
5 |
===================== |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
6 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
7 |
While creating an instance, a configuration file is generated in:: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
8 |
|
2445
6f065b366d14
rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2172
diff
changeset
|
9 |
$ (CW_INSTANCES_DIR) / <instance> / <configuration name>.conf |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
10 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
11 |
For example:: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
12 |
|
2539
0f26a76b0348
[doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2476
diff
changeset
|
13 |
/etc/cubicweb.d/myblog/all-in-one.conf |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
14 |
|
4747
516e971f10ea
[book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3740
diff
changeset
|
15 |
It is a simple text file in the INI format |
516e971f10ea
[book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3740
diff
changeset
|
16 |
(http://en.wikipedia.org/wiki/INI_file). In the following description, |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
17 |
each option name is prefixed with its own section and followed by its |
301 | 18 |
default value if necessary, e.g. "`<section>.<option>` [value]." |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
19 |
|
11690
15715274a631
[doc] Document configuration override by environment variables
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10491
diff
changeset
|
20 |
.. note:: At runtime, configuration options can be overriden by environments |
15715274a631
[doc] Document configuration override by environment variables
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10491
diff
changeset
|
21 |
variables which name follows the option name with ``-`` replaced by ``_`` |
15715274a631
[doc] Document configuration override by environment variables
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10491
diff
changeset
|
22 |
and a ``CW_`` prefix. For instance ``CW_BASE_URL=https://www.example.com`` |
15715274a631
[doc] Document configuration override by environment variables
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10491
diff
changeset
|
23 |
would override the ``base-url`` configuration option. |
15715274a631
[doc] Document configuration override by environment variables
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10491
diff
changeset
|
24 |
|
8480
086cff6a306a
[book] fix build warnings/errors. Closes #2430042
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8271
diff
changeset
|
25 |
.. _`WebServerConfig`: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
26 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
27 |
Configuring the Web server |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
28 |
-------------------------- |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
29 |
:`web.auth-model` [cookie]: |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
30 |
authentication mode, cookie or http |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
31 |
:`web.realm`: |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2445
diff
changeset
|
32 |
realm of the instance in http authentication mode |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
33 |
:`web.http-session-time` [0]: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
34 |
period of inactivity of an HTTP session before it closes automatically. |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
35 |
Duration in seconds, 0 meaning no expiration (or more exactly at the |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
36 |
closing of the browser client) |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
37 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
38 |
:`main.anonymous-user`, `main.anonymous-password`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
39 |
login and password to use to connect to the RQL server with |
1398
5fe84a5f7035
rename internal entity types to have CW prefix instead of E
sylvain.thenault@logilab.fr
parents:
301
diff
changeset
|
40 |
HTTP anonymous connection. CWUser account should exist. |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
41 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
42 |
:`main.base-url`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
43 |
url base site to be used to generate the urls of web pages |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
44 |
|
11913
4516c3956d46
Drop support for https-url in all-in-one.conf
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
11690
diff
changeset
|
45 |
Apache configuration |
4516c3956d46
Drop support for https-url in all-in-one.conf
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
11690
diff
changeset
|
46 |
```````````````````` |
4516c3956d46
Drop support for https-url in all-in-one.conf
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
11690
diff
changeset
|
47 |
It is possible to use apache (for example) as proxy. |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
48 |
|
7482
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
49 |
For this to work you have to activate the following apache modules : |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
50 |
|
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
51 |
* rewrite |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
52 |
* proxy |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
53 |
* http_proxy |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
54 |
|
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
55 |
The command on Debian based systems for that is :: |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
56 |
|
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
57 |
a2enmod rewrite http_proxy proxy |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
58 |
/etc/init.d/apache2 restart |
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
59 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
60 |
:Example: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
61 |
|
11913
4516c3956d46
Drop support for https-url in all-in-one.conf
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
11690
diff
changeset
|
62 |
For an apache redirection of a site accessible via `http://localhost/demo` while cubicweb is |
4516c3956d46
Drop support for https-url in all-in-one.conf
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
11690
diff
changeset
|
63 |
actually running on port 8080::: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
64 |
|
7483
b9740d6a1ec3
[doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7482
diff
changeset
|
65 |
ProxyPreserveHost On |
7482
0fa5dee25b7d
[doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7226
diff
changeset
|
66 |
RewriteEngine On |
4852
1693d6174251
[documentation] fix errors in book chapter instance-config
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
4749
diff
changeset
|
67 |
RewriteCond %{REQUEST_URI} ^/demo |
1461
023b123ab76b
[doc] Splits initial set-up section in two sections => re-order part III.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
301
diff
changeset
|
68 |
RewriteRule ^/demo$ /demo/ |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
69 |
RewriteRule ^/demo/(.*) http://127.0.0.1:8080/$1 [L,P] |
2172
cf8f9180e63e
delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1714
diff
changeset
|
70 |
|
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
71 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
72 |
and we will file in the all-in-one.conf of the instance::: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
73 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
74 |
base-url = http://localhost/demo |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
75 |
|
7483
b9740d6a1ec3
[doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7482
diff
changeset
|
76 |
|
4749
1560d51385f0
[book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4747
diff
changeset
|
77 |
Setting up the web client |
1560d51385f0
[book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4747
diff
changeset
|
78 |
------------------------- |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
79 |
:`web.embed-allowed`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
80 |
regular expression matching sites which could be "embedded" in |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
81 |
the site (controllers 'embed') |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
82 |
:`web.submit-url`: |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2445
diff
changeset
|
83 |
url where the bugs encountered in the instance can be mailed to |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
84 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
85 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
86 |
RQL server configuration |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
87 |
------------------------ |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
88 |
:`main.host`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
89 |
host name if it can not be detected correctly |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
90 |
:`main.pid-file`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
91 |
file where will be written the server pid |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
92 |
:`main.uid`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
93 |
user account to use for launching the server when it is |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
94 |
root launched by init |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
95 |
:`main.session-time [30*60]`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
96 |
timeout of a RQL session |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
97 |
:`main.query-log-file`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
98 |
file where all requests RQL executed by the server are written |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
99 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
100 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
101 |
Configuring e-mail |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
102 |
------------------ |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
103 |
RQL and web server side: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
104 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
105 |
:`email.mangle-mails [no]`: |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
106 |
indicates whether the email addresses must be displayed as is or |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
107 |
transformed |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
108 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
109 |
RQL server side: |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
110 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
111 |
:`email.smtp-host [mail]`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
112 |
hostname hosting the SMTP server to use for outgoing mail |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
113 |
:`email.smtp-port [25]`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
114 |
SMTP server port to use for outgoing mail |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
115 |
:`email.sender-name`: |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2445
diff
changeset
|
116 |
name to use for outgoing mail of the instance |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
117 |
:`email.sender-addr`: |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2445
diff
changeset
|
118 |
address for outgoing mail of the instance |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
119 |
:`email.default dest-addrs`: |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
120 |
destination addresses by default, if used by the configuration of the |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
121 |
dissemination of the model (separated by commas) |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
122 |
:`email.supervising-addrs`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
123 |
destination addresses of e-mails of supervision (separated by |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
124 |
commas) |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
125 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
126 |
|
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
127 |
Configuring logging |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
128 |
------------------- |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
129 |
:`main.log-threshold`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
130 |
level of filtering messages (DEBUG, INFO, WARNING, ERROR) |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
131 |
:`main.log-file`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
132 |
file to write messages |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
133 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
134 |
|
8032
bcb87336c7d2
[doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7483
diff
changeset
|
135 |
.. _PersistentProperties: |
bcb87336c7d2
[doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7483
diff
changeset
|
136 |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
1477
diff
changeset
|
137 |
Configuring persistent properties |
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
1477
diff
changeset
|
138 |
--------------------------------- |
1398
5fe84a5f7035
rename internal entity types to have CW prefix instead of E
sylvain.thenault@logilab.fr
parents:
301
diff
changeset
|
139 |
Other configuration settings are in the form of entities `CWProperty` |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
140 |
in the database. It must be edited via the web interface or by |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
141 |
RQL queries. |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
142 |
|
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
143 |
:`ui.encoding`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
144 |
Character encoding to use for the web |
5306
763319a51e72
[doc/book] some fixes for vregistry, selectors & appobjects
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4852
diff
changeset
|
145 |
:`navigation.short-line-size`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
146 |
number of characters for "short" display |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
147 |
:`navigation.page-size`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
148 |
maximum number of entities to show per results page |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
149 |
:`navigation.related-limit`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
150 |
number of related entities to show up on primary entity view |
93
9c919a47e140
[doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff
changeset
|
151 |
:`navigation.combobox-limit`: |
207
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
152 |
number of entities unrelated to show up on the drop-down lists of |
7985963869f9
[doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
127
diff
changeset
|
153 |
the sight on an editing entity view |
9571
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
154 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
155 |
Cross-Origin Resource Sharing |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
156 |
----------------------------- |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
157 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
158 |
CubicWeb provides some support for the CORS_ protocol. For now, the |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
159 |
provided implementation only deals with access to a CubicWeb instance |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
160 |
as a whole. Support for a finer granularity may be considered in the |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
161 |
future. |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
162 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
163 |
Specificities of the provided implementation: |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
164 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
165 |
- ``Access-Control-Allow-Credentials`` is always true |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
166 |
- ``Access-Control-Allow-Origin`` header in response will never be |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
167 |
``*`` |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
168 |
- ``Access-Control-Expose-Headers`` can be configured globally (see below) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
169 |
- ``Access-Control-Max-Age`` can be configured globally (see below) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
170 |
- ``Access-Control-Allow-Methods`` can be configured globally (see below) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
171 |
- ``Access-Control-Allow-Headers`` can be configured globally (see below) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
172 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
173 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
174 |
A few parameters can be set to configure the CORS_ capabilities of CubicWeb. |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
175 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
176 |
.. _CORS: http://www.w3.org/TR/cors/ |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
177 |
|
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
178 |
:`access-control-allow-origin`: |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
179 |
comma-separated list of allowed origin domains or "*" for any domain |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
180 |
:`access-control-allow-methods`: |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
181 |
comma-separated list of allowed HTTP methods |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
182 |
:`access-control-max-age`: |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
183 |
maximum age of cross-origin resource sharing (in seconds) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
184 |
:`access-control-allow-headers`: |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
185 |
comma-separated list of allowed HTTP custom headers (used in simple requests) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
186 |
:`access-control-expose-headers`: |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
187 |
comma-separated list of allowed HTTP custom headers (used in preflight requests) |
aaf83cc07eed
[web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8480
diff
changeset
|
188 |