First Commit
[librecmc/package-feed.git] / net / radicale / files / radicale.config
1 #
2 # You find additional information on Radicale Homepage
3 # http://radicale.org
4 #
5 # OpenWrt's wiki needs to be setup/updated ;-)
6 #
7 # if setting additional options please remember that UCI does not support
8 # section names and option names with "-" (Dash) inside their name
9 # to use them anyway replace "-" with "_" (Underscore)
10 # Each Radicale's config [section] is setup as UCI config setting 'section'
11 #
12
13 ####################################################
14 # OpenWrt specific settings
15 # not part of radicale package
16 #
17 config  system 'radicale'
18         # delayed startup at boot (default 10 seconds)
19         # to wait for netifd to bring up interfaces
20         # during this time iface hotplug events are ignored
21 #       option  boot_delay      '10'
22
23 ####################################################
24 # Server options
25 #
26 config setting 'server'
27
28         # hostname:port
29         # IPv4 syntax: address:port
30         # IPv6 syntax: [address]:port
31         # ATTENTION:
32         # only use ports > 1024 (non-privileged Ports)
33         # because this implementation is running as non-root user
34         # Default: 0.0.0.0:5232
35 #       list hosts '0.0.0.0:5232'
36 #       list hosts 'localhost:5232'
37
38         # SSL flag, enable HTTPS protocol
39         # Default: 0 (disabled)
40 #       option ssl '1'
41
42         # SSL Protocol used. See python's ssl module for available values
43         # Default: PROTOCOL_SSLv23
44 #       option protocol 'PROTOCOL_SSLv23'
45
46         # Ciphers available. See python's ssl module for available ciphers
47 #       option ciphers ''
48
49         # SSL certificate path and file
50 #       option certificate '/etc/radicale/ssl/server.crt'
51
52         # SSL private key path and file
53 #       option key '/etc/radicale/ssl/server.key'
54
55         # Reverse DNS to resolve client address in logs
56         # Default: 0 (disabled)
57 #       option dns_lookup '1'
58
59         # Message displayed in the client when a password is needed
60 #       option realm 'Radicale - Password Required'
61
62
63 ####################################################
64 # Encoding options
65 #
66 config  setting 'encoding'
67
68         # Encoding for responding requests
69 #       option  request 'utf-8'
70
71         # Encoding for storing local collections
72 #       option  stock   'utf-8'
73
74
75 ####################################################
76 # Authentication options
77 #
78 config  setting 'auth'
79
80         # Authentication method
81         # Value: None | htpasswd | IMAP | LDAP | PAM | courier | http | remote_user | custom
82         # Default: None
83         # if setting 'htpasswd' the file /etc/radicale/users is used (hardcoded)
84
85         # Htpasswd encryption method
86         # Value: plain | sha1 | ssha | crypt
87 #       option htpasswd_encryption 'crypt'
88
89         # for other authenication methods consult Radicale documentation
90         # and set options here
91
92
93 ####################################################
94 # Git default options
95 #
96 config  setting 'git'
97
98         # Git default options
99 #       option committer 'Radicale <radicale@example.com>'
100
101
102 ####################################################
103 # Rights backend
104 #
105 config setting 'rights'
106
107         # Value: None | authenticated | owner_only | owner_write | from_file | custom
108         # Default: None
109         # if setting 'from_file' the file /etc/radicale/rights is used (hardcoded)
110
111         # Custom rights handler
112 #       option custom_handler ''
113
114
115 ####################################################
116 # Storage backend
117 # -------
118 # WARNING: ONLY "filesystem" IS DOCUMENTED AND TESTED,
119 #          OTHER BACKENDS ARE NOT READY FOR PRODUCTION.
120 # -------
121 #
122 config setting 'storage'
123         # Value: filesystem | multifilesystem | database | custom
124         option  type                    'filesystem'
125         option  filesystem_folder       '/srv/radicale'
126
127
128 ####################################################
129 # Additional HTTP headers
130 #
131 config  setting 'headers'
132         # enable all if using CardDavMATE-, CalDavZAP- or InfCloud- WEBclient
133 #       list    Access_Control_Allow_Origin     '*'
134 #       list    Access_Control_Allow_Methods    'GET'
135 #       list    Access_Control_Allow_Methods    'POST'
136 #       list    Access_Control_Allow_Methods    'OPTIONS'
137 #       list    Access_Control_Allow_Methods    'PROPFIND'
138 #       list    Access_Control_Allow_Methods    'PROPPATCH'
139 #       list    Access_Control_Allow_Methods    'REPORT'
140 #       list    Access_Control_Allow_Methods    'PUT'
141 #       list    Access_Control_Allow_Methods    'MOVE'
142 #       list    Access_Control_Allow_Methods    'DELETE'
143 #       list    Access_Control_Allow_Methods    'LOCK'
144 #       list    Access_Control_Allow_Methods    'UNLOCK'
145 #       list    Access_Control_Allow_Headers    'User-Agent'
146 #       list    Access_Control_Allow_Headers    'Authorization'
147 #       list    Access_Control_Allow_Headers    'Content-type'
148 #       list    Access_Control_Allow_Headers    'Depth'
149 #       list    Access_Control_Allow_Headers    'If-match'
150 #       list    Access_Control_Allow_Headers    'If-None-Match'
151 #       list    Access_Control_Allow_Headers    'Lock-Token'
152 #       list    Access_Control_Allow_Headers    'Timeout'
153 #       list    Access_Control_Allow_Headers    'Destination'
154 #       list    Access_Control_Allow_Headers    'Overwrite'
155 #       list    Access_Control_Allow_Headers    'X-client'
156 #       list    Access_Control_Allow_Headers    'X-Requested-With'
157 #       list    Access_Control_Expose_Headers   'Etag'
158
159
160 ####################################################
161 # Global logging options
162 #
163 config setting 'logging'
164
165         # Set the default logging level to debug for all outputs (ignore output level settings)
166         # Default: 0 (disabled)
167 #       option  debug   '1'
168         # Log all environment variables (including those set in the shell) when starting
169         # Default: 0 (disabled)
170 #       option  full_environment '1'
171
172
173 ####################################################
174 # Spezial logging options
175 # !!! not documented in Radicale documentation
176 # !!! special settings for this implementation
177 #
178 config logging 'logger'
179
180         # Level: DEBUG | INFO | WARNING | ERROR | CRITICAL
181         # To nearly disable logging set level to critical
182
183         # log level on console
184 #       option  console_level   'ERROR'
185
186         # Here we use Rotating Logfiles in this implementation
187         # !!! if maxbytes and/or backupcount is set to 0  !!!
188         # !!! file rotation is disabled and logfile grows endless !!!
189         # log level
190 #       option  file_level      'INFO'
191         # directory where log files are written
192 #       option  file_path       '/var/log/radicale'
193         # max size of each logfile (see warning above)
194 #       option  file_maxbytes   '8196'
195         # number of backup files to create (see warning above)
196 #       option  file_backupcount        '1'
197
198         # log level for syslog logging
199 #       option  syslog_level    'WARNING'
200