doc/book/en/admin/instance-config.rst
author Nicolas Chauvat <nicolas.chauvat@logilab.fr>
Fri, 14 Mar 2014 11:20:53 +0100
changeset 9571 aaf83cc07eed
parent 8480 086cff6a306a
child 10235 684215aca046
permissions -rw-r--r--
[web] implement cross origin resource sharing (CORS) (closes #2491768) Partial implementation that is enough to get started but leaves out some of the advanced features like caching and non-simple methods and headers.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 229
diff changeset
    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
8480
086cff6a306a [book] fix build warnings/errors. Closes #2430042
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8271
diff changeset
    20
.. _`WebServerConfig`:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    21
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    22
Configuring the Web server
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    23
--------------------------
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    24
:`web.auth-model` [cookie]:
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    25
    authentication mode, cookie or http
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    26
:`web.realm`:
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2445
diff changeset
    27
    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
    28
:`web.http-session-time` [0]:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    29
    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
    30
    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
    31
    closing of the browser client)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    32
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    33
:`main.anonymous-user`, `main.anonymous-password`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    34
    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
    35
    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
    36
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    37
:`main.base-url`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    38
    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
    39
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    40
Https configuration
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    41
```````````````````
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    42
It is possible to make a site accessible for anonymous http connections
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    43
and https for authenticated users. This requires to
229
767ff7f5d5a7 [doc] Replace all : s/by example/for example/
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 207
diff changeset
    44
use apache (for example) for redirection and the variable `main.https-url`
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    45
of configuration file.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    46
7482
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    47
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
    48
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    49
* rewrite
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    50
* proxy
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    51
* http_proxy
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    52
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    53
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
    54
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    55
  a2enmod rewrite http_proxy proxy
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    56
  /etc/init.d/apache2 restart
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    57
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    58
:Example:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    59
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    60
   For an apache redirection of a site accessible via `http://localhost/demo`
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    61
   and `https://localhost/demo` and actually running on port 8080, it
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    62
   takes to the http:::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    63
7483
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    64
     ProxyPreserveHost On
7482
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    65
     RewriteEngine On
4852
1693d6174251 [documentation] fix errors in book chapter instance-config
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 4749
diff changeset
    66
     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
    67
     RewriteRule ^/demo$ /demo/
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    68
     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
    69
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    70
   and for the https:::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    71
7483
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    72
     ProxyPreserveHost On
7482
0fa5dee25b7d [doc] Small addition to apache configuration in book
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 7226
diff changeset
    73
     RewriteEngine On
4852
1693d6174251 [documentation] fix errors in book chapter instance-config
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 4749
diff changeset
    74
     RewriteCond %{REQUEST_URI} ^/ demo
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    75
     RewriteRule ^/demo$/demo/
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    76
     RewriteRule ^/demo/(.*) http://127.0.0.1:8080/https/$1 [L,P]
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    77
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    78
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    79
   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
    80
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    81
     base-url = http://localhost/demo
4852
1693d6174251 [documentation] fix errors in book chapter instance-config
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 4749
diff changeset
    82
     https-url = https://localhost/demo
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    83
7483
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    84
Notice that if you simply want a site accessible through https, not *both* http
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    85
and https, simply set `base-url` to the https url and the first section into your
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    86
apache configuration (as you would have to do for an http configuration with an
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    87
apache front-end).
b9740d6a1ec3 [doc, apache] add ProxyPreserveHost hint + note about https /w http configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7482
diff changeset
    88
4749
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
    89
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
    90
-------------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    91
:`web.embed-allowed`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    92
    regular expression matching sites which could be "embedded" in
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    93
    the site (controllers 'embed')
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    94
:`web.submit-url`:
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2445
diff changeset
    95
    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
    96
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    97
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    98
RQL server configuration
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
    99
------------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   100
:`main.host`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   101
    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
   102
:`main.pid-file`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   103
    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
   104
:`main.uid`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   105
    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
   106
    root launched by init
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   107
:`main.session-time [30*60]`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   108
    timeout of a RQL session
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   109
:`main.query-log-file`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   110
    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
   111
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   112
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   113
Pyro configuration for the instance
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   114
-----------------------------------
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   115
Web server side:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   116
4749
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   117
:`pyro.pyro-instance-id`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   118
    pyro identifier of RQL server (e.g. the instance name)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   119
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   120
RQL server side:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   121
4749
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   122
:`main.pyro-server`:
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   123
    boolean to switch on/off pyro server-side
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   124
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   125
:`pyro.pyro-host`:
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   126
    pyro host:port number. If no port is specified, it is assigned
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   127
    automatically.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   128
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   129
RQL and web servers side:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   130
4749
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   131
:`pyro.pyro-ns-host`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   132
    hostname hosting pyro server name. If no value is
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   133
    specified, it is located by a request from broadcast
4749
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   134
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   135
:`pyro.pyro-ns-group`:
1560d51385f0 [book/admin/pyro] fix pyro options, give a small setup example
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4747
diff changeset
   136
    pyro group in which to save the instance (will default to 'cubicweb')
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   137
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   138
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   139
Configuring e-mail
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   140
------------------
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   141
RQL and web server side:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   142
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   143
:`email.mangle-mails [no]`:
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   144
    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
   145
    transformed
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   146
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   147
RQL server side:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   148
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   149
:`email.smtp-host [mail]`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   150
    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
   151
:`email.smtp-port [25]`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   152
    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
   153
:`email.sender-name`:
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2445
diff changeset
   154
    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
   155
:`email.sender-addr`:
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2445
diff changeset
   156
    address for outgoing mail of the instance
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   157
:`email.default dest-addrs`:
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   158
    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
   159
    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
   160
:`email.supervising-addrs`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   161
    destination addresses of e-mails of supervision (separated by
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   162
    commas)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   163
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   164
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   165
Configuring logging
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   166
-------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   167
:`main.log-threshold`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   168
    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
   169
:`main.log-file`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   170
    file to write messages
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   171
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   172
8032
bcb87336c7d2 [doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7483
diff changeset
   173
.. _PersistentProperties:
bcb87336c7d2 [doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7483
diff changeset
   174
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents: 1477
diff changeset
   175
Configuring persistent properties
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents: 1477
diff changeset
   176
---------------------------------
1398
5fe84a5f7035 rename internal entity types to have CW prefix instead of E
sylvain.thenault@logilab.fr
parents: 301
diff changeset
   177
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
   178
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
   179
RQL queries.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   180
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   181
:`ui.encoding`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   182
    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
   183
:`navigation.short-line-size`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   184
    number of characters for "short" display
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   185
:`navigation.page-size`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   186
    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
   187
:`navigation.related-limit`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   188
    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
   189
:`navigation.combobox-limit`:
207
7985963869f9 [doc] Translation to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 127
diff changeset
   190
    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
   191
    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
   192
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   193
Cross-Origin Resource Sharing
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   194
-----------------------------
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   195
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   196
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
   197
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
   198
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
   199
future.
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   200
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   201
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
   202
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   203
- ``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
   204
- ``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
   205
  ``*``
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   206
- ``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
   207
- ``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
   208
- ``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
   209
- ``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
   210
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   211
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   212
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
   213
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   214
.. _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
   215
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   216
:`access-control-allow-origin`:
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   217
   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
   218
:`access-control-allow-methods`:
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   219
   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
   220
:`access-control-max-age`:
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   221
   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
   222
:`access-control-allow-headers`:
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   223
   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
   224
:`access-control-expose-headers`:
aaf83cc07eed [web] implement cross origin resource sharing (CORS) (closes #2491768)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 8480
diff changeset
   225
   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
   226