| 3334 |
14 May 07 |
nicklas |
1 |
<?xml version="1.0" encoding="UTF-8"?> |
| 3334 |
14 May 07 |
nicklas |
2 |
<!DOCTYPE appendix PUBLIC |
| 3334 |
14 May 07 |
nicklas |
3 |
"-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" |
| 3334 |
14 May 07 |
nicklas |
4 |
"../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd"> |
| 3334 |
14 May 07 |
nicklas |
5 |
<!-- |
| 3334 |
14 May 07 |
nicklas |
$Id$ |
| 3334 |
14 May 07 |
nicklas |
7 |
|
| 3675 |
16 Aug 07 |
jari |
Copyright (C) 2007 Peter Johansson, Nicklas Nordborg, Martin Svensson |
| 3334 |
14 May 07 |
nicklas |
9 |
|
| 3334 |
14 May 07 |
nicklas |
This file is part of BASE - BioArray Software Environment. |
| 3334 |
14 May 07 |
nicklas |
Available at http://base.thep.lu.se/ |
| 3334 |
14 May 07 |
nicklas |
12 |
|
| 3334 |
14 May 07 |
nicklas |
BASE is free software; you can redistribute it and/or |
| 3334 |
14 May 07 |
nicklas |
modify it under the terms of the GNU General Public License |
| 4477 |
05 Sep 08 |
jari |
as published by the Free Software Foundation; either version 3 |
| 3334 |
14 May 07 |
nicklas |
of the License, or (at your option) any later version. |
| 3334 |
14 May 07 |
nicklas |
17 |
|
| 3334 |
14 May 07 |
nicklas |
BASE is distributed in the hope that it will be useful, |
| 3334 |
14 May 07 |
nicklas |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 3334 |
14 May 07 |
nicklas |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 3334 |
14 May 07 |
nicklas |
GNU General Public License for more details. |
| 3334 |
14 May 07 |
nicklas |
22 |
|
| 3334 |
14 May 07 |
nicklas |
You should have received a copy of the GNU General Public License |
| 4509 |
11 Sep 08 |
jari |
along with BASE. If not, see <http://www.gnu.org/licenses/>. |
| 3334 |
14 May 07 |
nicklas |
25 |
--> |
| 3334 |
14 May 07 |
nicklas |
26 |
|
| 3334 |
14 May 07 |
nicklas |
27 |
<appendix id="appendix.base.config"> |
| 5782 |
04 Oct 11 |
nicklas |
28 |
<?dbhtml filename="base.config.html" ?> |
| 3334 |
14 May 07 |
nicklas |
29 |
|
| 3334 |
14 May 07 |
nicklas |
30 |
<title>base.config reference</title> |
| 3334 |
14 May 07 |
nicklas |
31 |
|
| 3334 |
14 May 07 |
nicklas |
32 |
<para> |
| 3340 |
15 May 07 |
nicklas |
33 |
The <filename>base.config</filename> file is the main configuration file |
| 3340 |
15 May 07 |
nicklas |
34 |
for BASE. It is located in the <filename><basedir>/www/WEB-INF/classes</filename> |
| 5680 |
29 Jun 11 |
nicklas |
35 |
directory. Most configuration properties have sensible defaults or are only used |
| 5680 |
29 Jun 11 |
nicklas |
36 |
for advanced features. However, a few are required and may need to be specified |
| 5680 |
29 Jun 11 |
nicklas |
37 |
or changed: |
| 3334 |
14 May 07 |
nicklas |
38 |
</para> |
| 3334 |
14 May 07 |
nicklas |
39 |
|
| 5680 |
29 Jun 11 |
nicklas |
40 |
<itemizedlist> |
| 5680 |
29 Jun 11 |
nicklas |
41 |
<listitem> |
| 7521 |
06 Nov 18 |
nicklas |
42 |
<property>db.dialect</property>, |
| 5680 |
29 Jun 11 |
nicklas |
43 |
<property>db.url</property>, <property>db.username</property>, |
| 5680 |
29 Jun 11 |
nicklas |
44 |
<property>db.password</property>: |
| 5680 |
29 Jun 11 |
nicklas |
45 |
Settings for connecting to the database. |
| 5680 |
29 Jun 11 |
nicklas |
46 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
47 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
48 |
<property>userfiles</property>: Setting that specify where uploaded files are stored |
| 5680 |
29 Jun 11 |
nicklas |
49 |
on the BASE server. |
| 5680 |
29 Jun 11 |
nicklas |
50 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
51 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
52 |
<property>plugins.dir</property>: Settings that specify where plug-ins and extensions |
| 5680 |
29 Jun 11 |
nicklas |
53 |
are installed. |
| 5680 |
29 Jun 11 |
nicklas |
54 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
55 |
</itemizedlist> |
| 5680 |
29 Jun 11 |
nicklas |
56 |
|
| 3340 |
15 May 07 |
nicklas |
57 |
<simplesect id="appendix.base.config.dbdriver"> |
| 3340 |
15 May 07 |
nicklas |
58 |
<title>Database driver section</title> |
| 3340 |
15 May 07 |
nicklas |
59 |
|
| 3340 |
15 May 07 |
nicklas |
60 |
<para> |
| 3340 |
15 May 07 |
nicklas |
61 |
This section has parameters needed for the database connection, such |
| 3340 |
15 May 07 |
nicklas |
62 |
as the database dialect, username and password. |
| 3340 |
15 May 07 |
nicklas |
63 |
</para> |
| 3340 |
15 May 07 |
nicklas |
64 |
|
| 3340 |
15 May 07 |
nicklas |
65 |
<variablelist> |
| 3340 |
15 May 07 |
nicklas |
66 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
67 |
<term><property>db.dialect</property></term> |
| 3340 |
15 May 07 |
nicklas |
68 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
69 |
<para> |
| 3340 |
15 May 07 |
nicklas |
70 |
The Hibernate dialect to use when generating SQL commands to the database. |
| 3340 |
15 May 07 |
nicklas |
71 |
Use: |
| 3340 |
15 May 07 |
nicklas |
72 |
<itemizedlist> |
| 3340 |
15 May 07 |
nicklas |
73 |
<listitem> |
| 6468 |
10 Jun 14 |
nicklas |
74 |
<userinput>org.hibernate.dialect.PostgreSQL9Dialect</userinput> |
| 4487 |
08 Sep 08 |
jari |
75 |
for PostgreSQL |
| 3340 |
15 May 07 |
nicklas |
76 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
77 |
</itemizedlist> |
| 3340 |
15 May 07 |
nicklas |
78 |
Other dialects may work but are not supported. |
| 3340 |
15 May 07 |
nicklas |
79 |
</para> |
| 3340 |
15 May 07 |
nicklas |
80 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
81 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
82 |
|
| 3340 |
15 May 07 |
nicklas |
83 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
84 |
<term><property>db.url</property></term> |
| 3340 |
15 May 07 |
nicklas |
85 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
86 |
<para> |
| 4487 |
08 Sep 08 |
jari |
87 |
The connection URL that locates the BASE database. The exact syntax |
| 7997 |
09 Aug 21 |
nicklas |
88 |
of the string depends on the JDBC driver. Here is an example which |
| 3340 |
15 May 07 |
nicklas |
89 |
leaves all other settings to their defaults: |
| 3340 |
15 May 07 |
nicklas |
90 |
<itemizedlist> |
| 3340 |
15 May 07 |
nicklas |
91 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
92 |
<userinput>jdbc:postgresql:basedb</userinput> |
| 4487 |
08 Sep 08 |
jari |
93 |
for PostgreSQL |
| 3340 |
15 May 07 |
nicklas |
94 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
95 |
</itemizedlist> |
| 3340 |
15 May 07 |
nicklas |
96 |
|
| 3340 |
15 May 07 |
nicklas |
97 |
You can get more information about the parameters that are supported on the |
| 3340 |
15 May 07 |
nicklas |
98 |
connection URL by reading the documentation from |
| 3340 |
15 May 07 |
nicklas |
99 |
<ulink url="http://jdbc.postgresql.org/documentation/81/connect.html" |
| 4487 |
08 Sep 08 |
jari |
100 |
>PostgreSQL</ulink>. |
| 3340 |
15 May 07 |
nicklas |
101 |
|
| 3340 |
15 May 07 |
nicklas |
102 |
</para> |
| 3340 |
15 May 07 |
nicklas |
103 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
104 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
105 |
|
| 3340 |
15 May 07 |
nicklas |
106 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
107 |
<term><property>db.dynamic.catalog</property></term> |
| 3340 |
15 May 07 |
nicklas |
108 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
109 |
<para> |
| 3340 |
15 May 07 |
nicklas |
110 |
The name of the catalog where the dynamic database used to store |
| 3340 |
15 May 07 |
nicklas |
111 |
analysed data is located. If not specified the same catalog as the regular |
| 3340 |
15 May 07 |
nicklas |
112 |
database is used. The exact meaning of catalog depends on the actual database. |
| 7997 |
09 Aug 21 |
nicklas |
113 |
PostgreSQL does not support connecting to multiple |
| 3340 |
15 May 07 |
nicklas |
114 |
databases with the same connection so this should have the same value as the |
| 3340 |
15 May 07 |
nicklas |
115 |
database in the <property>db.url</property> setting. |
| 3340 |
15 May 07 |
nicklas |
116 |
</para> |
| 3340 |
15 May 07 |
nicklas |
117 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
118 |
</varlistentry> |
| 3334 |
14 May 07 |
nicklas |
119 |
|
| 3340 |
15 May 07 |
nicklas |
120 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
121 |
<term><property>db.dynamic.schema</property></term> |
| 3340 |
15 May 07 |
nicklas |
122 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
123 |
<para> |
| 3340 |
15 May 07 |
nicklas |
124 |
The name of the schema where the dynamic database used to store |
| 7997 |
09 Aug 21 |
nicklas |
125 |
analysed data is located. PostgreSQL supports schemas and we recommend that the dynamic |
| 3340 |
15 May 07 |
nicklas |
126 |
part is created in it's own schema to avoid mixing the dynamic tables with |
| 3347 |
16 May 07 |
martin |
127 |
the regular ones. |
| 3340 |
15 May 07 |
nicklas |
128 |
</para> |
| 3340 |
15 May 07 |
nicklas |
129 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
130 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
131 |
|
| 3340 |
15 May 07 |
nicklas |
132 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
133 |
<term><property>db.username</property></term> |
| 3340 |
15 May 07 |
nicklas |
134 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
135 |
<para> |
| 3340 |
15 May 07 |
nicklas |
136 |
The username to connect to the database. The user should have full permission |
| 3347 |
16 May 07 |
martin |
137 |
to both the regular and the dynamic database. |
| 3340 |
15 May 07 |
nicklas |
138 |
</para> |
| 3340 |
15 May 07 |
nicklas |
139 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
140 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
141 |
|
| 3340 |
15 May 07 |
nicklas |
142 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
143 |
<term><property>db.password</property></term> |
| 3340 |
15 May 07 |
nicklas |
144 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
145 |
<para> |
| 3340 |
15 May 07 |
nicklas |
146 |
The password for the user. |
| 3340 |
15 May 07 |
nicklas |
147 |
</para> |
| 3340 |
15 May 07 |
nicklas |
148 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
149 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
150 |
|
| 3340 |
15 May 07 |
nicklas |
151 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
152 |
<term><property>db.batch-size</property></term> |
| 3340 |
15 May 07 |
nicklas |
153 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
154 |
<para> |
| 3340 |
15 May 07 |
nicklas |
155 |
The batch size to use when inserting/updating items with the Batch API. |
| 3340 |
15 May 07 |
nicklas |
156 |
A higher value requires more memory, a lower value degrades performance |
| 3340 |
15 May 07 |
nicklas |
157 |
since the number of database connections increases. The default value is |
| 3340 |
15 May 07 |
nicklas |
158 |
50. |
| 3340 |
15 May 07 |
nicklas |
159 |
</para> |
| 3340 |
15 May 07 |
nicklas |
160 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
161 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
162 |
|
| 3340 |
15 May 07 |
nicklas |
163 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
164 |
<term><property>db.queries</property></term> |
| 3340 |
15 May 07 |
nicklas |
165 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
166 |
<para> |
| 3347 |
16 May 07 |
martin |
167 |
The location of an XML file which contains database-specific |
| 3487 |
13 Jun 07 |
peter |
168 |
queries overriding those that does not work from the |
| 3340 |
15 May 07 |
nicklas |
169 |
<filename>/common-queries.xml</filename> file. Use: |
| 3340 |
15 May 07 |
nicklas |
170 |
|
| 3340 |
15 May 07 |
nicklas |
171 |
<itemizedlist> |
| 3340 |
15 May 07 |
nicklas |
172 |
<listitem><userinput>/mysql-queries.xml</userinput> for MySQL</listitem> |
| 4487 |
08 Sep 08 |
jari |
173 |
<listitem><userinput>/postgres-queries.xml</userinput> for PostgreSQL</listitem> |
| 3340 |
15 May 07 |
nicklas |
174 |
</itemizedlist> |
| 3340 |
15 May 07 |
nicklas |
175 |
See also <xref linkend="appendix.otherconfig.sql" />. |
| 3340 |
15 May 07 |
nicklas |
176 |
</para> |
| 3340 |
15 May 07 |
nicklas |
177 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
178 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
179 |
|
| 3340 |
15 May 07 |
nicklas |
180 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
181 |
<term><property>db.extended-properties</property></term> |
| 3340 |
15 May 07 |
nicklas |
182 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
183 |
<para> |
| 3340 |
15 May 07 |
nicklas |
184 |
The location of an XML file describing the extended properties for extendable |
| 3340 |
15 May 07 |
nicklas |
185 |
item types, ie. the reporters. The default value is <userinput>/extended-properties.xml</userinput>. |
| 3340 |
15 May 07 |
nicklas |
186 |
See <xref linkend="appendix.extendedproperties" /> for more information |
| 3340 |
15 May 07 |
nicklas |
187 |
about extended properties. |
| 3340 |
15 May 07 |
nicklas |
188 |
</para> |
| 3340 |
15 May 07 |
nicklas |
189 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
190 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
191 |
|
| 3340 |
15 May 07 |
nicklas |
192 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
193 |
<term><property>db.raw-data-types</property></term> |
| 3340 |
15 May 07 |
nicklas |
194 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
195 |
<para> |
| 3340 |
15 May 07 |
nicklas |
196 |
The location of an XML file describing all raw data types and their properties. |
| 3340 |
15 May 07 |
nicklas |
197 |
The default value is <userinput>/raw-data-types.xml</userinput>. |
| 3340 |
15 May 07 |
nicklas |
198 |
See <xref linkend="appendix.rawdatatypes" /> for more information |
| 3340 |
15 May 07 |
nicklas |
199 |
about raw data types. |
| 3340 |
15 May 07 |
nicklas |
200 |
</para> |
| 3340 |
15 May 07 |
nicklas |
201 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
202 |
</varlistentry> |
| 5023 |
27 Jul 09 |
nicklas |
203 |
|
| 5023 |
27 Jul 09 |
nicklas |
204 |
<varlistentry> |
| 5023 |
27 Jul 09 |
nicklas |
205 |
<term><property>db.cleanup.interval</property></term> |
| 5023 |
27 Jul 09 |
nicklas |
206 |
<listitem> |
| 5023 |
27 Jul 09 |
nicklas |
207 |
<para> |
| 5023 |
27 Jul 09 |
nicklas |
208 |
Interval in hours between database cleanups. Set this to |
| 5023 |
27 Jul 09 |
nicklas |
209 |
0 to disable (recommened for job agents). The default value |
| 5680 |
29 Jun 11 |
nicklas |
210 |
is 24. The cleanup will remove entries in the database that |
| 5680 |
29 Jun 11 |
nicklas |
211 |
have been orphaned due to other information that has been removed. |
| 5680 |
29 Jun 11 |
nicklas |
212 |
For example, change history entries, any-to-any links and |
| 5680 |
29 Jun 11 |
nicklas |
213 |
permission keys. |
| 5023 |
27 Jul 09 |
nicklas |
214 |
</para> |
| 5023 |
27 Jul 09 |
nicklas |
215 |
</listitem> |
| 5023 |
27 Jul 09 |
nicklas |
216 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
217 |
</variablelist> |
| 3340 |
15 May 07 |
nicklas |
218 |
|
| 3340 |
15 May 07 |
nicklas |
219 |
</simplesect> |
| 3340 |
15 May 07 |
nicklas |
220 |
|
| 3340 |
15 May 07 |
nicklas |
221 |
<simplesect id="appendix.base.config.authentication"> |
| 3340 |
15 May 07 |
nicklas |
222 |
<title>Authentication section</title> |
| 3340 |
15 May 07 |
nicklas |
223 |
<para> |
| 3340 |
15 May 07 |
nicklas |
224 |
This section describes parameters that are needed if you are |
| 3347 |
16 May 07 |
martin |
225 |
going to use external authentication. If you let BASE handle this |
| 3347 |
16 May 07 |
martin |
226 |
you will not have to bother about these settings. See |
| 6429 |
10 Mar 14 |
nicklas |
227 |
<xref linkend="extensions_developer.login-manager"/> for more information about |
| 3340 |
15 May 07 |
nicklas |
228 |
external authentication. |
| 3340 |
15 May 07 |
nicklas |
229 |
</para> |
| 3340 |
15 May 07 |
nicklas |
230 |
|
| 3340 |
15 May 07 |
nicklas |
231 |
<variablelist> |
| 3340 |
15 May 07 |
nicklas |
232 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
233 |
<term><property>auth.synchronize</property></term> |
| 3340 |
15 May 07 |
nicklas |
234 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
235 |
<para> |
| 3340 |
15 May 07 |
nicklas |
236 |
If this setting is 1 or TRUE, BASE will synchronize the extra |
| 6429 |
10 Mar 14 |
nicklas |
237 |
information (name, address, email, etc.) sent by the authentication manager |
| 6429 |
10 Mar 14 |
nicklas |
238 |
when a user logs in to BASE. This setting is ignored if the manager does not |
| 6429 |
10 Mar 14 |
nicklas |
239 |
provide extra information. |
| 3340 |
15 May 07 |
nicklas |
240 |
</para> |
| 3340 |
15 May 07 |
nicklas |
241 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
242 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
243 |
|
| 3340 |
15 May 07 |
nicklas |
244 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
245 |
<term><property>auth.cachepasswords</property></term> |
| 3340 |
15 May 07 |
nicklas |
246 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
247 |
<para> |
| 3340 |
15 May 07 |
nicklas |
248 |
If passwords should be cached by BASE or not. If the passwords are |
| 3340 |
15 May 07 |
nicklas |
249 |
cached a user may login to BASE even if the external authentication |
| 3340 |
15 May 07 |
nicklas |
250 |
server is down. The cached passwords are only used if the external |
| 3487 |
13 Jun 07 |
peter |
251 |
authentication does not answer properly. |
| 3340 |
15 May 07 |
nicklas |
252 |
</para> |
| 3340 |
15 May 07 |
nicklas |
253 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
254 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
255 |
|
| 3340 |
15 May 07 |
nicklas |
256 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
257 |
<term><property>auth.daystocache</property></term> |
| 3340 |
15 May 07 |
nicklas |
258 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
259 |
<para> |
| 3340 |
15 May 07 |
nicklas |
260 |
How many days a cached password is valid if caching is enabled. A value of |
| 3340 |
15 May 07 |
nicklas |
261 |
0 caches the passwords forever. |
| 3340 |
15 May 07 |
nicklas |
262 |
</para> |
| 3340 |
15 May 07 |
nicklas |
263 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
264 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
265 |
</variablelist> |
| 3340 |
15 May 07 |
nicklas |
266 |
</simplesect> |
| 3340 |
15 May 07 |
nicklas |
267 |
|
| 3340 |
15 May 07 |
nicklas |
268 |
<simplesect id="appendix.base.config.jobqueue"> |
| 3340 |
15 May 07 |
nicklas |
269 |
<title>Internal job queue section</title> |
| 3340 |
15 May 07 |
nicklas |
270 |
|
| 3340 |
15 May 07 |
nicklas |
271 |
<para> |
| 3340 |
15 May 07 |
nicklas |
272 |
This section contains setting that control the internal job queue. |
| 3340 |
15 May 07 |
nicklas |
273 |
The internal job queue is a simple queue that executes jobs more or |
| 3340 |
15 May 07 |
nicklas |
274 |
less in the order they were added to the queue. To make sure long-running |
| 3487 |
13 Jun 07 |
peter |
275 |
jobs do not block the queue, there are four slots that uses the |
| 3347 |
16 May 07 |
martin |
276 |
expected execution time to decide if a job should be allowed to execute |
| 3340 |
15 May 07 |
nicklas |
277 |
or not. |
| 3340 |
15 May 07 |
nicklas |
278 |
</para> |
| 3340 |
15 May 07 |
nicklas |
279 |
|
| 3340 |
15 May 07 |
nicklas |
280 |
<variablelist> |
| 3340 |
15 May 07 |
nicklas |
281 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
282 |
<term><property>jobqueue.internal.enabled</property></term> |
| 3340 |
15 May 07 |
nicklas |
283 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
284 |
<para> |
| 3340 |
15 May 07 |
nicklas |
285 |
If <userinput>0</userinput> or <userinput>FALSE</userinput> the internal |
| 3871 |
22 Oct 07 |
nicklas |
286 |
job queue will be disabled. |
| 3340 |
15 May 07 |
nicklas |
287 |
</para> |
| 3340 |
15 May 07 |
nicklas |
288 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
289 |
</varlistentry> |
| 3871 |
22 Oct 07 |
nicklas |
290 |
|
| 3871 |
22 Oct 07 |
nicklas |
291 |
<varlistentry> |
| 3871 |
22 Oct 07 |
nicklas |
292 |
<term><property>jobqueue.internal.runallplugins</property></term> |
| 3871 |
22 Oct 07 |
nicklas |
293 |
<listitem> |
| 3871 |
22 Oct 07 |
nicklas |
294 |
<para> |
| 3871 |
22 Oct 07 |
nicklas |
295 |
If <userinput>1</userinput> or <userinput>TRUE</userinput> the internal |
| 3871 |
22 Oct 07 |
nicklas |
296 |
job queue will ignore the <property>useInternalJobQueue</property> |
| 3871 |
22 Oct 07 |
nicklas |
297 |
flag specified on plug-ins. If <userinput>0</userinput> or <userinput>FALSE</userinput> |
| 3871 |
22 Oct 07 |
nicklas |
298 |
the internal job queue will only execute plug-ins which has |
| 3871 |
22 Oct 07 |
nicklas |
299 |
<property>useInternalJobQueue=true</property> |
| 3871 |
22 Oct 07 |
nicklas |
300 |
</para> |
| 3871 |
22 Oct 07 |
nicklas |
301 |
</listitem> |
| 3871 |
22 Oct 07 |
nicklas |
302 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
303 |
|
| 3340 |
15 May 07 |
nicklas |
304 |
<varlistentry> |
| 4093 |
18 Jan 08 |
enell |
305 |
<term><property>jobqueue.internal.signalreceiver.class</property></term> |
| 4093 |
18 Jan 08 |
enell |
306 |
<listitem> |
| 4093 |
18 Jan 08 |
enell |
307 |
<para> |
| 4093 |
18 Jan 08 |
enell |
308 |
A class implementing the <interfacename docapi="net.sf.basedb.core.signal" |
| 4093 |
18 Jan 08 |
enell |
309 |
>SignalReceiver</interfacename> |
| 4093 |
18 Jan 08 |
enell |
310 |
interface. The class must have a public no-argument constructor. If |
| 4093 |
18 Jan 08 |
enell |
311 |
no value is specified the default setting is: |
| 4093 |
18 Jan 08 |
enell |
312 |
<classname docapi="net.sf.basedb.core.signal" |
| 4093 |
18 Jan 08 |
enell |
313 |
>net.sf.basedb.core.signal.LocalSignalReceiver</classname>. |
| 4093 |
18 Jan 08 |
enell |
314 |
</para> |
| 4093 |
18 Jan 08 |
enell |
315 |
<para> |
| 4093 |
18 Jan 08 |
enell |
316 |
Change to <classname docapi="net.sf.basedb.core.signal" |
| 4093 |
18 Jan 08 |
enell |
317 |
>net.sf.basedb.core.signal.SocketSignalReceiver</classname> |
| 4093 |
18 Jan 08 |
enell |
318 |
if the internal job queue must be able to receive signals from outside |
| 4093 |
18 Jan 08 |
enell |
319 |
this JVM. |
| 4093 |
18 Jan 08 |
enell |
320 |
</para> |
| 4093 |
18 Jan 08 |
enell |
321 |
</listitem> |
| 4093 |
18 Jan 08 |
enell |
322 |
</varlistentry> |
| 4093 |
18 Jan 08 |
enell |
323 |
|
| 4093 |
18 Jan 08 |
enell |
324 |
<varlistentry> |
| 4093 |
18 Jan 08 |
enell |
325 |
<term><property>jobqueue.internal.signalreceiver.init</property></term> |
| 4093 |
18 Jan 08 |
enell |
326 |
<listitem> |
| 4093 |
18 Jan 08 |
enell |
327 |
<para> |
| 4093 |
18 Jan 08 |
enell |
328 |
Initialisation string sent to <methodname>SignalReceiver.init()</methodname>. |
| 4093 |
18 Jan 08 |
enell |
329 |
The syntax and meaning of the string depends on the actual implementation |
| 4487 |
08 Sep 08 |
jari |
330 |
that is used. Please see the Javadoc for more information. |
| 4093 |
18 Jan 08 |
enell |
331 |
</para> |
| 4093 |
18 Jan 08 |
enell |
332 |
</listitem> |
| 4093 |
18 Jan 08 |
enell |
333 |
</varlistentry> |
| 4093 |
18 Jan 08 |
enell |
334 |
|
| 4093 |
18 Jan 08 |
enell |
335 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
336 |
<term><property>jobqueue.internal.checkinterval</property></term> |
| 3340 |
15 May 07 |
nicklas |
337 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
338 |
<para> |
| 3340 |
15 May 07 |
nicklas |
339 |
The number of seconds between checks to the database for jobs |
| 3340 |
15 May 07 |
nicklas |
340 |
that are waiting for execution. |
| 3340 |
15 May 07 |
nicklas |
341 |
</para> |
| 3340 |
15 May 07 |
nicklas |
342 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
343 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
344 |
|
| 3340 |
15 May 07 |
nicklas |
345 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
346 |
<term><property>jobqueue.internal.shortest.threads</property></term> |
| 3340 |
15 May 07 |
nicklas |
347 |
<term><property>jobqueue.internal.short.threads</property></term> |
| 3340 |
15 May 07 |
nicklas |
348 |
<term><property>jobqueue.internal.medium.threads</property></term> |
| 3340 |
15 May 07 |
nicklas |
349 |
<term><property>jobqueue.internal.long.threads</property></term> |
| 3340 |
15 May 07 |
nicklas |
350 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
351 |
<para> |
| 3340 |
15 May 07 |
nicklas |
352 |
Maximum number of threads to reserve for jobs with a given expected |
| 3340 |
15 May 07 |
nicklas |
353 |
execution time. A job with a short execution time may use a thread |
| 3340 |
15 May 07 |
nicklas |
354 |
from one of the slots with longer execution time. When all threads |
| 3340 |
15 May 07 |
nicklas |
355 |
are in use, new jobs will have to wait until an executing job |
| 3340 |
15 May 07 |
nicklas |
356 |
has finished. |
| 3340 |
15 May 07 |
nicklas |
357 |
</para> |
| 3340 |
15 May 07 |
nicklas |
358 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
359 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
360 |
|
| 3340 |
15 May 07 |
nicklas |
361 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
362 |
<term><property>jobqueue.internal.shortest.threadpriority</property></term> |
| 3340 |
15 May 07 |
nicklas |
363 |
<term><property>jobqueue.internal.short.threadpriority</property></term> |
| 3340 |
15 May 07 |
nicklas |
364 |
<term><property>jobqueue.internal.medium.threadpriority</property></term> |
| 3340 |
15 May 07 |
nicklas |
365 |
<term><property>jobqueue.internal.long.threadpriority</property></term> |
| 3340 |
15 May 07 |
nicklas |
366 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
367 |
<para> |
| 3340 |
15 May 07 |
nicklas |
368 |
The priority to give to jobs. The priority is a value between 1 and 10. |
| 5820 |
24 Oct 11 |
nicklas |
369 |
See <ulink url="http://download.oracle.com/javase/6/docs/api/java/lang/Thread.html" |
| 5820 |
24 Oct 11 |
nicklas |
370 |
>http://download.oracle.com/javase/6/docs/api/java/lang/Thread.html</ulink> |
| 3340 |
15 May 07 |
nicklas |
371 |
for more information about thread priorities. |
| 3340 |
15 May 07 |
nicklas |
372 |
</para> |
| 3340 |
15 May 07 |
nicklas |
373 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
374 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
375 |
</variablelist> |
| 3340 |
15 May 07 |
nicklas |
376 |
|
| 3340 |
15 May 07 |
nicklas |
377 |
</simplesect> |
| 3340 |
15 May 07 |
nicklas |
378 |
|
| 3340 |
15 May 07 |
nicklas |
379 |
<simplesect id="appendix.base.config.jobagent"> |
| 3340 |
15 May 07 |
nicklas |
380 |
<title>Job agent section</title> |
| 3340 |
15 May 07 |
nicklas |
381 |
|
| 3340 |
15 May 07 |
nicklas |
382 |
<para> |
| 3340 |
15 May 07 |
nicklas |
383 |
This section contains settings that BASE uses when communicating |
| 5738 |
15 Sep 11 |
nicklas |
384 |
with external job agents. See <xref linkend="installation.jobagents"/> |
| 3340 |
15 May 07 |
nicklas |
385 |
for more information about job agents. |
| 3340 |
15 May 07 |
nicklas |
386 |
</para> |
| 3340 |
15 May 07 |
nicklas |
387 |
|
| 3340 |
15 May 07 |
nicklas |
388 |
<variablelist> |
| 3340 |
15 May 07 |
nicklas |
389 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
390 |
<term><property>agent.maxage</property></term> |
| 3340 |
15 May 07 |
nicklas |
391 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
392 |
<para> |
| 3340 |
15 May 07 |
nicklas |
393 |
Number of seconds to keep job agent information in the internal cache. |
| 3347 |
16 May 07 |
martin |
394 |
The information includes, CPU and memory usage and the status of executing |
| 3340 |
15 May 07 |
nicklas |
395 |
jobs. This setting controls how long the information is kept in the cache |
| 3340 |
15 May 07 |
nicklas |
396 |
before a new request is made to the job agent. The default value is 60 seconds. |
| 3340 |
15 May 07 |
nicklas |
397 |
</para> |
| 3340 |
15 May 07 |
nicklas |
398 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
399 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
400 |
|
| 3340 |
15 May 07 |
nicklas |
401 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
402 |
<term><property>agent.connection.timeout</property></term> |
| 3340 |
15 May 07 |
nicklas |
403 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
404 |
<para> |
| 3347 |
16 May 07 |
martin |
405 |
The timeout in milliseconds to wait for a response from a job agent |
| 3340 |
15 May 07 |
nicklas |
406 |
when sending a request to it. The default timeout is 1000 milliseconds. |
| 3340 |
15 May 07 |
nicklas |
407 |
This should be more than enough if the job agent is on the internal |
| 3340 |
15 May 07 |
nicklas |
408 |
network, but may have to be increased if it is located somewhere else. |
| 3340 |
15 May 07 |
nicklas |
409 |
</para> |
| 3340 |
15 May 07 |
nicklas |
410 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
411 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
412 |
|
| 3340 |
15 May 07 |
nicklas |
413 |
</variablelist> |
| 3340 |
15 May 07 |
nicklas |
414 |
|
| 3340 |
15 May 07 |
nicklas |
415 |
</simplesect> |
| 3340 |
15 May 07 |
nicklas |
416 |
|
| 3340 |
15 May 07 |
nicklas |
417 |
|
| 5071 |
21 Aug 09 |
nicklas |
418 |
<simplesect id="appendix.base.config.log"> |
| 5071 |
21 Aug 09 |
nicklas |
419 |
<title>Change history logging section</title> |
| 5071 |
21 Aug 09 |
nicklas |
420 |
|
| 5071 |
21 Aug 09 |
nicklas |
421 |
<para> |
| 5071 |
21 Aug 09 |
nicklas |
422 |
This section contains settings for logging the change history |
| 6080 |
07 Aug 12 |
nicklas |
423 |
of items. Logging is disabled by default, but BASE ships |
| 6080 |
07 Aug 12 |
nicklas |
424 |
with one implementation that log changes to the database. |
| 6080 |
07 Aug 12 |
nicklas |
425 |
To enable it, log in to the web client with administrator |
| 6080 |
07 Aug 12 |
nicklas |
426 |
privileges and enable the <guilabel>Database log manager</guilabel> |
| 6080 |
07 Aug 12 |
nicklas |
427 |
extension. See <xref linkend="extensions_developer.logging" /> for more |
| 6080 |
07 Aug 12 |
nicklas |
428 |
information about implementing custom logging. |
| 5071 |
21 Aug 09 |
nicklas |
429 |
</para> |
| 5071 |
21 Aug 09 |
nicklas |
430 |
|
| 5071 |
21 Aug 09 |
nicklas |
431 |
<variablelist> |
| 5071 |
21 Aug 09 |
nicklas |
432 |
<varlistentry> |
| 5071 |
21 Aug 09 |
nicklas |
433 |
<term><property>changelog.show-in-web</property></term> |
| 5071 |
21 Aug 09 |
nicklas |
434 |
<listitem> |
| 5071 |
21 Aug 09 |
nicklas |
435 |
<para> |
| 5071 |
21 Aug 09 |
nicklas |
436 |
A boolean value that specifies if the <guilabel>Change history</guilabel> |
| 5071 |
21 Aug 09 |
nicklas |
437 |
tab should be visible in the web interface or not. The change history |
| 5071 |
21 Aug 09 |
nicklas |
438 |
tab will show log information that has been stored in the database |
| 5071 |
21 Aug 09 |
nicklas |
439 |
and it doesn't make sense to show this tab unless the |
| 6080 |
07 Aug 12 |
nicklas |
440 |
<guilabel>Database log manager</guilabel> has been enabled. |
| 5071 |
21 Aug 09 |
nicklas |
441 |
</para> |
| 5071 |
21 Aug 09 |
nicklas |
442 |
|
| 5071 |
21 Aug 09 |
nicklas |
443 |
<note> |
| 5071 |
21 Aug 09 |
nicklas |
444 |
<para> |
| 5071 |
21 Aug 09 |
nicklas |
445 |
By default, only users that are members of the |
| 5071 |
21 Aug 09 |
nicklas |
446 |
<guilabel>Administrator</guilabel> role have permission to |
| 5071 |
21 Aug 09 |
nicklas |
447 |
view the change history. To give other users the same permission, |
| 5071 |
21 Aug 09 |
nicklas |
448 |
add the <guilabel>Change history</guilabel> permission to |
| 5071 |
21 Aug 09 |
nicklas |
449 |
the appropriate role(s). |
| 5071 |
21 Aug 09 |
nicklas |
450 |
</para> |
| 5071 |
21 Aug 09 |
nicklas |
451 |
</note> |
| 5071 |
21 Aug 09 |
nicklas |
452 |
</listitem> |
| 5071 |
21 Aug 09 |
nicklas |
453 |
</varlistentry> |
| 5071 |
21 Aug 09 |
nicklas |
454 |
<varlistentry> |
| 5071 |
21 Aug 09 |
nicklas |
455 |
<term><property>changelog.dblogger.detailed-properties</property></term> |
| 5071 |
21 Aug 09 |
nicklas |
456 |
<listitem> |
| 5071 |
21 Aug 09 |
nicklas |
457 |
<para> |
| 5071 |
21 Aug 09 |
nicklas |
458 |
A boolean value that specifies the amount of information |
| 6080 |
07 Aug 12 |
nicklas |
459 |
that should be logged by the database log manager. If set, the log |
| 6080 |
07 Aug 12 |
nicklas |
460 |
will contain information about which properties that was modified on each item, |
| 6080 |
07 Aug 12 |
nicklas |
461 |
otherwise only the type of change (create, update, delete) is logged. |
| 5071 |
21 Aug 09 |
nicklas |
462 |
</para> |
| 5071 |
21 Aug 09 |
nicklas |
463 |
</listitem> |
| 5071 |
21 Aug 09 |
nicklas |
464 |
</varlistentry> |
| 5071 |
21 Aug 09 |
nicklas |
465 |
</variablelist> |
| 5071 |
21 Aug 09 |
nicklas |
466 |
|
| 5071 |
21 Aug 09 |
nicklas |
467 |
</simplesect> |
| 5071 |
21 Aug 09 |
nicklas |
468 |
|
| 5442 |
07 Oct 10 |
nicklas |
469 |
<simplesect id="appendix.base.config.smtp"> |
| 5442 |
07 Oct 10 |
nicklas |
470 |
<title>SMTP server section</title> |
| 5442 |
07 Oct 10 |
nicklas |
471 |
|
| 5442 |
07 Oct 10 |
nicklas |
472 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
473 |
This section contains settings for the SMTP server used for |
| 5442 |
07 Oct 10 |
nicklas |
474 |
outgoing mail. This is optional, and if not configured outgoing |
| 7412 |
11 Oct 17 |
nicklas |
475 |
mail (including 2-factor login) will be disabled. |
| 5442 |
07 Oct 10 |
nicklas |
476 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
477 |
|
| 5442 |
07 Oct 10 |
nicklas |
478 |
<variablelist> |
| 5442 |
07 Oct 10 |
nicklas |
479 |
<varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
480 |
<term><property>mail.server.host</property></term> |
| 5442 |
07 Oct 10 |
nicklas |
481 |
<listitem> |
| 5442 |
07 Oct 10 |
nicklas |
482 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
483 |
The host name of the SMTP server to use for outgoing mail. |
| 5442 |
07 Oct 10 |
nicklas |
484 |
If not configured mailing functions will be disabled. |
| 5442 |
07 Oct 10 |
nicklas |
485 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
486 |
</listitem> |
| 5442 |
07 Oct 10 |
nicklas |
487 |
</varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
488 |
<varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
489 |
<term><property>mail.server.port</property></term> |
| 5442 |
07 Oct 10 |
nicklas |
490 |
<listitem> |
| 5442 |
07 Oct 10 |
nicklas |
491 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
492 |
The port the SMTP server is listening on. If not configured a |
| 5442 |
07 Oct 10 |
nicklas |
493 |
default port is used. Eg. 25 for regular mail server, 465 for |
| 5442 |
07 Oct 10 |
nicklas |
494 |
SSL mail server. |
| 5442 |
07 Oct 10 |
nicklas |
495 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
496 |
</listitem> |
| 5442 |
07 Oct 10 |
nicklas |
497 |
</varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
498 |
<varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
499 |
<term><property>mail.server.ssl</property></term> |
| 5442 |
07 Oct 10 |
nicklas |
500 |
<listitem> |
| 5442 |
07 Oct 10 |
nicklas |
501 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
502 |
A boolean value that specifies if the SMTP server is using |
| 5442 |
07 Oct 10 |
nicklas |
503 |
SSL or not. |
| 5442 |
07 Oct 10 |
nicklas |
504 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
505 |
</listitem> |
| 5442 |
07 Oct 10 |
nicklas |
506 |
</varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
507 |
<varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
508 |
<term><property>mail.server.tls</property></term> |
| 5442 |
07 Oct 10 |
nicklas |
509 |
<listitem> |
| 5442 |
07 Oct 10 |
nicklas |
510 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
511 |
A boolean value that specifies if the SMTP server is using |
| 5442 |
07 Oct 10 |
nicklas |
512 |
TLS or not. |
| 5442 |
07 Oct 10 |
nicklas |
513 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
514 |
</listitem> |
| 5442 |
07 Oct 10 |
nicklas |
515 |
</varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
516 |
<varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
517 |
<term><property>mail.from.email</property></term> |
| 5442 |
07 Oct 10 |
nicklas |
518 |
<listitem> |
| 5442 |
07 Oct 10 |
nicklas |
519 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
520 |
The email address that will be used as the sender of outgoing |
| 5442 |
07 Oct 10 |
nicklas |
521 |
emails. If not configured mailing functions will be disabled. |
| 5442 |
07 Oct 10 |
nicklas |
522 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
523 |
</listitem> |
| 5442 |
07 Oct 10 |
nicklas |
524 |
</varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
525 |
<varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
526 |
<term><property>mail.from.name</property></term> |
| 5442 |
07 Oct 10 |
nicklas |
527 |
<listitem> |
| 5442 |
07 Oct 10 |
nicklas |
528 |
<para> |
| 5442 |
07 Oct 10 |
nicklas |
529 |
Thename that will be used as the sender of outgoing |
| 5442 |
07 Oct 10 |
nicklas |
530 |
emails. If not configured, a default name is automatically |
| 5442 |
07 Oct 10 |
nicklas |
531 |
generated using the host name of the BASE server. |
| 5442 |
07 Oct 10 |
nicklas |
532 |
</para> |
| 5442 |
07 Oct 10 |
nicklas |
533 |
</listitem> |
| 5442 |
07 Oct 10 |
nicklas |
534 |
</varlistentry> |
| 5442 |
07 Oct 10 |
nicklas |
535 |
</variablelist> |
| 5442 |
07 Oct 10 |
nicklas |
536 |
|
| 5442 |
07 Oct 10 |
nicklas |
537 |
</simplesect> |
| 5442 |
07 Oct 10 |
nicklas |
538 |
|
| 5680 |
29 Jun 11 |
nicklas |
539 |
<simplesect id="appendix.base.config.plugin"> |
| 5680 |
29 Jun 11 |
nicklas |
540 |
<title>Plug-ins and extensions</title> |
| 5680 |
29 Jun 11 |
nicklas |
541 |
<variablelist> |
| 5680 |
29 Jun 11 |
nicklas |
542 |
<varlistentry> |
| 5680 |
29 Jun 11 |
nicklas |
543 |
<term><property>plugins.dir</property></term> |
| 5680 |
29 Jun 11 |
nicklas |
544 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
545 |
<para> |
| 5680 |
29 Jun 11 |
nicklas |
546 |
The path to the directory where jar-files for external plug-ins and extensions |
| 5680 |
29 Jun 11 |
nicklas |
547 |
are located. All new plug-ins and extensions found in this directory, can be selected |
| 5680 |
29 Jun 11 |
nicklas |
548 |
for installation, see <xref linkend="plugins.installation" />. |
| 5680 |
29 Jun 11 |
nicklas |
549 |
</para> |
| 5680 |
29 Jun 11 |
nicklas |
550 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
551 |
</varlistentry> |
| 5680 |
29 Jun 11 |
nicklas |
552 |
|
| 5680 |
29 Jun 11 |
nicklas |
553 |
<varlistentry> |
| 5680 |
29 Jun 11 |
nicklas |
554 |
<term><property>plugins.autounload</property></term> |
| 5680 |
29 Jun 11 |
nicklas |
555 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
556 |
<para> |
| 5680 |
29 Jun 11 |
nicklas |
557 |
Enable this setting to let BASE detect if a plug-in JAR file is changed |
| 5680 |
29 Jun 11 |
nicklas |
558 |
and automatically load and use the new code instead of the old code. |
| 5680 |
29 Jun 11 |
nicklas |
559 |
This setting is useful for plug-in developers since they don't have to |
| 5680 |
29 Jun 11 |
nicklas |
560 |
restart the web server each time the plug-in is recompiled. |
| 5680 |
29 Jun 11 |
nicklas |
561 |
<itemizedlist> |
| 5680 |
29 Jun 11 |
nicklas |
562 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
563 |
<simpara> |
| 5680 |
29 Jun 11 |
nicklas |
564 |
<userinput>true,yes,1</userinput> |
| 5680 |
29 Jun 11 |
nicklas |
565 |
to enable |
| 5680 |
29 Jun 11 |
nicklas |
566 |
</simpara> |
| 5680 |
29 Jun 11 |
nicklas |
567 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
568 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
569 |
<simpara> |
| 5680 |
29 Jun 11 |
nicklas |
570 |
<userinput>false,no,0</userinput> |
| 5680 |
29 Jun 11 |
nicklas |
571 |
to disable (default if no value is specified) |
| 5680 |
29 Jun 11 |
nicklas |
572 |
</simpara> |
| 5680 |
29 Jun 11 |
nicklas |
573 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
574 |
</itemizedlist> |
| 5680 |
29 Jun 11 |
nicklas |
575 |
Note that extensions doesn't support this feature. Use the installation |
| 5680 |
29 Jun 11 |
nicklas |
576 |
wizard to update an extension. |
| 5680 |
29 Jun 11 |
nicklas |
577 |
</para> |
| 5680 |
29 Jun 11 |
nicklas |
578 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
579 |
</varlistentry> |
| 5680 |
29 Jun 11 |
nicklas |
580 |
|
| 5680 |
29 Jun 11 |
nicklas |
581 |
<varlistentry> |
| 5680 |
29 Jun 11 |
nicklas |
582 |
<term><property>extensions.disabled</property></term> |
| 5680 |
29 Jun 11 |
nicklas |
583 |
<listitem> |
| 5680 |
29 Jun 11 |
nicklas |
584 |
<para> |
| 5680 |
29 Jun 11 |
nicklas |
585 |
A boolean flag that, if set, disables all external extensions. |
| 5680 |
29 Jun 11 |
nicklas |
586 |
Plug-ins or core extensions will never be disabled. |
| 5680 |
29 Jun 11 |
nicklas |
587 |
</para> |
| 5680 |
29 Jun 11 |
nicklas |
588 |
</listitem> |
| 5680 |
29 Jun 11 |
nicklas |
589 |
</varlistentry> |
| 5680 |
29 Jun 11 |
nicklas |
590 |
|
| 5680 |
29 Jun 11 |
nicklas |
591 |
</variablelist> |
| 5680 |
29 Jun 11 |
nicklas |
592 |
</simplesect> |
| 5442 |
07 Oct 10 |
nicklas |
593 |
|
| 5680 |
29 Jun 11 |
nicklas |
594 |
<simplesect id="appendix.base.config.other"> |
| 3340 |
15 May 07 |
nicklas |
595 |
<title>Other settings</title> |
| 7395 |
12 Jun 17 |
nicklas |
596 |
|
| 3340 |
15 May 07 |
nicklas |
597 |
<variablelist> |
| 3340 |
15 May 07 |
nicklas |
598 |
<varlistentry> |
| 7395 |
12 Jun 17 |
nicklas |
599 |
<term><property>app.title</property></term> |
| 7395 |
12 Jun 17 |
nicklas |
600 |
<listitem> |
| 7395 |
12 Jun 17 |
nicklas |
601 |
<para> |
| 7395 |
12 Jun 17 |
nicklas |
602 |
The title that is displayed in the browser tab. Use <code>$VERSION</code> |
| 7395 |
12 Jun 17 |
nicklas |
603 |
to include the current BASE version and <code>$SERVER</code> to include the |
| 7395 |
12 Jun 17 |
nicklas |
604 |
server name. |
| 7395 |
12 Jun 17 |
nicklas |
605 |
</para> |
| 7395 |
12 Jun 17 |
nicklas |
606 |
</listitem> |
| 7395 |
12 Jun 17 |
nicklas |
607 |
</varlistentry> |
| 7395 |
12 Jun 17 |
nicklas |
608 |
|
| 7395 |
12 Jun 17 |
nicklas |
609 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
610 |
<term><property>userfiles</property></term> |
| 3340 |
15 May 07 |
nicklas |
611 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
612 |
<para> |
| 3340 |
15 May 07 |
nicklas |
613 |
The path to the directory where uploaded and generated files should |
| 7598 |
22 Feb 19 |
nicklas |
614 |
be stored. This is the primary file storage. Files are not |
| 3340 |
15 May 07 |
nicklas |
615 |
stored in the same directory structure or with the same names as in |
| 4487 |
08 Sep 08 |
jari |
616 |
the BASE file system. The internal structure may contain sub-directories. |
| 3340 |
15 May 07 |
nicklas |
617 |
</para> |
| 3340 |
15 May 07 |
nicklas |
618 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
619 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
620 |
|
| 3340 |
15 May 07 |
nicklas |
621 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
622 |
<term><property>permission.timeout</property></term> |
| 3340 |
15 May 07 |
nicklas |
623 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
624 |
<para> |
| 3340 |
15 May 07 |
nicklas |
625 |
Number of minutes to cache a logged in user's permissions before |
| 3340 |
15 May 07 |
nicklas |
626 |
reloading them. The default value is 10. This setting affect how |
| 3340 |
15 May 07 |
nicklas |
627 |
quickly a changed permission propagate to a logged in user. Permissions |
| 3340 |
15 May 07 |
nicklas |
628 |
are always reloaded when a user logs in. |
| 3340 |
15 May 07 |
nicklas |
629 |
</para> |
| 3340 |
15 May 07 |
nicklas |
630 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
631 |
</varlistentry> |
| 3340 |
15 May 07 |
nicklas |
632 |
|
| 3340 |
15 May 07 |
nicklas |
633 |
<varlistentry> |
| 3340 |
15 May 07 |
nicklas |
634 |
<term><property>cache.timeout</property></term> |
| 3340 |
15 May 07 |
nicklas |
635 |
<listitem> |
| 3340 |
15 May 07 |
nicklas |
636 |
<para> |
| 3340 |
15 May 07 |
nicklas |
637 |
Number of minutes to keep user sessions in the internal cache |
| 3340 |
15 May 07 |
nicklas |
638 |
before the user is automatically logged out. The timeout is counted |
| 3340 |
15 May 07 |
nicklas |
639 |
from the last access made from the user. |
| 3340 |
15 May 07 |
nicklas |
640 |
</para> |
| 3340 |
15 May 07 |
nicklas |
641 |
</listitem> |
| 3340 |
15 May 07 |
nicklas |
642 |
</varlistentry> |
| 4827 |
23 Mar 09 |
nicklas |
643 |
|
| 3347 |
16 May 07 |
martin |
644 |
<varlistentry> |
| 4827 |
23 Mar 09 |
nicklas |
645 |
<term><property>cache.static.disabled</property></term> |
| 4827 |
23 Mar 09 |
nicklas |
646 |
<listitem> |
| 4827 |
23 Mar 09 |
nicklas |
647 |
<para> |
| 4827 |
23 Mar 09 |
nicklas |
648 |
If the static cache should be enabled or disabled. It is enabled by |
| 4827 |
23 Mar 09 |
nicklas |
649 |
default. Disabling the static cache may reduce performance in some |
| 4827 |
23 Mar 09 |
nicklas |
650 |
cases. The static cache is used to cache processed information, |
| 4827 |
23 Mar 09 |
nicklas |
651 |
for example images, so that the database doesn't have to be queried |
| 4827 |
23 Mar 09 |
nicklas |
652 |
on every request. |
| 4827 |
23 Mar 09 |
nicklas |
653 |
</para> |
| 4827 |
23 Mar 09 |
nicklas |
654 |
</listitem> |
| 4827 |
23 Mar 09 |
nicklas |
655 |
</varlistentry> |
| 4827 |
23 Mar 09 |
nicklas |
656 |
|
| 4827 |
23 Mar 09 |
nicklas |
657 |
<varlistentry> |
| 4827 |
23 Mar 09 |
nicklas |
658 |
<term><property>cache.static.max-age</property></term> |
| 4827 |
23 Mar 09 |
nicklas |
659 |
<listitem> |
| 4827 |
23 Mar 09 |
nicklas |
660 |
<para> |
| 4827 |
23 Mar 09 |
nicklas |
661 |
The maximum age in days of files in the static cache. Files that |
| 4827 |
23 Mar 09 |
nicklas |
662 |
hasn't been accessed (read or written) in the specified amount |
| 4827 |
23 Mar 09 |
nicklas |
663 |
of time are deleted. |
| 4827 |
23 Mar 09 |
nicklas |
664 |
</para> |
| 4827 |
23 Mar 09 |
nicklas |
665 |
</listitem> |
| 4827 |
23 Mar 09 |
nicklas |
666 |
</varlistentry> |
| 4827 |
23 Mar 09 |
nicklas |
667 |
|
| 4827 |
23 Mar 09 |
nicklas |
668 |
<varlistentry> |
| 3347 |
16 May 07 |
martin |
669 |
<term><property>helptext.update</property></term> |
| 3347 |
16 May 07 |
martin |
670 |
<listitem> |
| 3347 |
16 May 07 |
martin |
671 |
<para> |
| 3347 |
16 May 07 |
martin |
672 |
Defines if already existing helptexts in BASE should be overwritten when |
| 3347 |
16 May 07 |
martin |
673 |
updating the program, |
| 5738 |
15 Sep 11 |
nicklas |
674 |
<xref linkend="installation.upgrade" /> |
| 3347 |
16 May 07 |
martin |
675 |
<itemizedlist> |
| 3347 |
16 May 07 |
martin |
676 |
<listitem> |
| 3347 |
16 May 07 |
martin |
677 |
<simpara> |
| 3347 |
16 May 07 |
martin |
678 |
<userinput>true</userinput> |
| 3347 |
16 May 07 |
martin |
679 |
will overwrite existing helptexts. |
| 3347 |
16 May 07 |
martin |
680 |
</simpara> |
| 3347 |
16 May 07 |
martin |
681 |
</listitem> |
| 3347 |
16 May 07 |
martin |
682 |
<listitem> |
| 3347 |
16 May 07 |
martin |
683 |
<simpara> |
| 3347 |
16 May 07 |
martin |
684 |
<userinput>false</userinput> |
| 3347 |
16 May 07 |
martin |
685 |
will leave the existing helptexts in database unchanged and only |
| 3347 |
16 May 07 |
martin |
686 |
insert new helptexts. |
| 3347 |
16 May 07 |
martin |
687 |
</simpara> |
| 3347 |
16 May 07 |
martin |
688 |
</listitem> |
| 3347 |
16 May 07 |
martin |
689 |
</itemizedlist> |
| 3347 |
16 May 07 |
martin |
690 |
</para> |
| 3347 |
16 May 07 |
martin |
691 |
</listitem> |
| 3347 |
16 May 07 |
martin |
692 |
</varlistentry> |
| 5409 |
16 Sep 10 |
nicklas |
693 |
|
| 5409 |
16 Sep 10 |
nicklas |
694 |
<varlistentry> |
| 5409 |
16 Sep 10 |
nicklas |
695 |
<term><property>locale.language</property></term> |
| 5409 |
16 Sep 10 |
nicklas |
696 |
<term><property>locale.country</property></term> |
| 5409 |
16 Sep 10 |
nicklas |
697 |
<term><property>locale.variant</property></term> |
| 5409 |
16 Sep 10 |
nicklas |
698 |
<listitem> |
| 5409 |
16 Sep 10 |
nicklas |
699 |
<para> |
| 5409 |
16 Sep 10 |
nicklas |
700 |
Configure the server to a specific locale. The language and |
| 5409 |
16 Sep 10 |
nicklas |
701 |
country should be valid ISO codes as specified by the |
| 5409 |
16 Sep 10 |
nicklas |
702 |
<ulink url="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html" |
| 5409 |
16 Sep 10 |
nicklas |
703 |
>java.util.Locale</ulink> documentation. The variant |
| 5409 |
16 Sep 10 |
nicklas |
704 |
can be any value that is valid as part of a filename. |
| 5409 |
16 Sep 10 |
nicklas |
705 |
</para> |
| 5409 |
16 Sep 10 |
nicklas |
706 |
|
| 5409 |
16 Sep 10 |
nicklas |
707 |
<note> |
| 5409 |
16 Sep 10 |
nicklas |
708 |
<para> |
| 5409 |
16 Sep 10 |
nicklas |
709 |
Note that language codes are usually lower-case but country codes are |
| 5409 |
16 Sep 10 |
nicklas |
710 |
upper case. Eg. <code>sv</code> is the language code for swedish, and |
| 5409 |
16 Sep 10 |
nicklas |
711 |
<code>SE</code> is the country code. |
| 5409 |
16 Sep 10 |
nicklas |
712 |
</para> |
| 5409 |
16 Sep 10 |
nicklas |
713 |
</note> |
| 5409 |
16 Sep 10 |
nicklas |
714 |
|
| 5409 |
16 Sep 10 |
nicklas |
715 |
<para> |
| 5409 |
16 Sep 10 |
nicklas |
716 |
This configuration can be used to provide translations to some parts of the web gui. |
| 5409 |
16 Sep 10 |
nicklas |
717 |
The aim is to externalize all hard-coded gui elements from the code but |
| 5409 |
16 Sep 10 |
nicklas |
718 |
it's a long way before this is a reality. The default text elements of |
| 5409 |
16 Sep 10 |
nicklas |
719 |
the gui are shipped within the BASE jar files and doesn't have any |
| 5409 |
16 Sep 10 |
nicklas |
720 |
locale-specific dependency. This means that unless a more specific |
| 5409 |
16 Sep 10 |
nicklas |
721 |
translation is provided the default texts are always used as a fallback. |
| 5409 |
16 Sep 10 |
nicklas |
722 |
Most of the default texts are found in property files in the |
| 5409 |
16 Sep 10 |
nicklas |
723 |
<filename>/net/sf/basedb/clients/web/resources</filename> |
| 5680 |
29 Jun 11 |
nicklas |
724 |
directory inside the <filename>base-webclient-3.x.jar</filename> |
| 5409 |
16 Sep 10 |
nicklas |
725 |
file. Translations should be located in the same relative path |
| 5409 |
16 Sep 10 |
nicklas |
726 |
either inside their own JAR file or in the <filename>WEB-INF/classes</filename> |
| 5409 |
16 Sep 10 |
nicklas |
727 |
directory. The file names should be extended with the language, country |
| 5409 |
16 Sep 10 |
nicklas |
728 |
and variant separated with an underscore. For example, files with a swedish |
| 5409 |
16 Sep 10 |
nicklas |
729 |
translation should be named <filename>*_sv.properties</filename>, and files |
| 5409 |
16 Sep 10 |
nicklas |
730 |
with a swedish translation in Finland using the 'foo' variant should be |
| 5409 |
16 Sep 10 |
nicklas |
731 |
named <filename>*_sv_FI_foo.properties</filename>. |
| 5409 |
16 Sep 10 |
nicklas |
732 |
</para> |
| 5409 |
16 Sep 10 |
nicklas |
733 |
|
| 5409 |
16 Sep 10 |
nicklas |
734 |
<note> |
| 5409 |
16 Sep 10 |
nicklas |
735 |
<para> |
| 5409 |
16 Sep 10 |
nicklas |
736 |
Note that it is valid to have empty values for language and/or country |
| 5409 |
16 Sep 10 |
nicklas |
737 |
and still specify a variant. Underscores are NOT collapsed. For |
| 5409 |
16 Sep 10 |
nicklas |
738 |
example, in a swedish translation using the 'foo' variant the |
| 5409 |
16 Sep 10 |
nicklas |
739 |
files should be named <filename>*_sv__foo.properties</filename>. |
| 5409 |
16 Sep 10 |
nicklas |
740 |
</para> |
| 5409 |
16 Sep 10 |
nicklas |
741 |
</note> |
| 5409 |
16 Sep 10 |
nicklas |
742 |
|
| 5409 |
16 Sep 10 |
nicklas |
743 |
<important> |
| 5409 |
16 Sep 10 |
nicklas |
744 |
<para> |
| 5409 |
16 Sep 10 |
nicklas |
745 |
All files should be saved in UTF-8 format. |
| 5409 |
16 Sep 10 |
nicklas |
746 |
</para> |
| 5409 |
16 Sep 10 |
nicklas |
747 |
</important> |
| 5409 |
16 Sep 10 |
nicklas |
748 |
|
| 5409 |
16 Sep 10 |
nicklas |
749 |
</listitem> |
| 5409 |
16 Sep 10 |
nicklas |
750 |
</varlistentry> |
| 5409 |
16 Sep 10 |
nicklas |
751 |
|
| 3340 |
15 May 07 |
nicklas |
752 |
</variablelist> |
| 3340 |
15 May 07 |
nicklas |
753 |
</simplesect> |
| 3340 |
15 May 07 |
nicklas |
754 |
|
| 5336 |
04 May 10 |
nicklas |
755 |
<simplesect id="appendix.base.config.ssl"> |
| 5336 |
04 May 10 |
nicklas |
756 |
<title>SSL section</title> |
| 5336 |
04 May 10 |
nicklas |
757 |
|
| 5336 |
04 May 10 |
nicklas |
758 |
<para> |
| 5362 |
16 Jun 10 |
nicklas |
759 |
This section is for global configuration of SSL (HTTPS) connection |
| 5680 |
29 Jun 11 |
nicklas |
760 |
settings used when BASE need to access external file items. Note that |
| 5680 |
29 Jun 11 |
nicklas |
761 |
users can re-configure SSL connections per-file |
| 5362 |
16 Jun 10 |
nicklas |
762 |
basis by setting up File-server items, so there is usually no need |
| 5362 |
16 Jun 10 |
nicklas |
763 |
to change anything in this section. If the majority of users on the |
| 5362 |
16 Jun 10 |
nicklas |
764 |
BASE server is using a particular https file server for external files it |
| 5362 |
16 Jun 10 |
nicklas |
765 |
may make sense to register the certificates globally. |
| 5336 |
04 May 10 |
nicklas |
766 |
</para> |
| 5336 |
04 May 10 |
nicklas |
767 |
|
| 5336 |
04 May 10 |
nicklas |
768 |
<para> |
| 5362 |
16 Jun 10 |
nicklas |
769 |
When a https connection is made the server must present a valid |
| 5362 |
16 Jun 10 |
nicklas |
770 |
certificate or the client (BASE) will refuse to connect to it. |
| 5362 |
16 Jun 10 |
nicklas |
771 |
Typically, all certificates that have been signed by a recognised |
| 5362 |
16 Jun 10 |
nicklas |
772 |
Certification Authority are considered valid. The major reason for |
| 5362 |
16 Jun 10 |
nicklas |
773 |
configuring this section is to provide support for servers that |
| 5362 |
16 Jun 10 |
nicklas |
774 |
use a self-signed certificate. |
| 5362 |
16 Jun 10 |
nicklas |
775 |
Server-side certificate are stored in a <emphasis>trust-store</emphasis>. |
| 5362 |
16 Jun 10 |
nicklas |
776 |
A default trust-store is shipped with the Java runtime installation |
| 5362 |
16 Jun 10 |
nicklas |
777 |
and is found in <filename><java-home>/jre/lib/security/cacerts</filename>. |
| 5362 |
16 Jun 10 |
nicklas |
778 |
This file contains the certificates of all recognised certification authorities. |
| 5336 |
04 May 10 |
nicklas |
779 |
</para> |
| 5362 |
16 Jun 10 |
nicklas |
780 |
|
| 5336 |
04 May 10 |
nicklas |
781 |
<para> |
| 5362 |
16 Jun 10 |
nicklas |
782 |
A https server may also require that the client has a valid certificate |
| 5362 |
16 Jun 10 |
nicklas |
783 |
in order to accept connections from it. Typically, the owner of the |
| 5362 |
16 Jun 10 |
nicklas |
784 |
server issues a certificate that the client must install in order |
| 5362 |
16 Jun 10 |
nicklas |
785 |
to access the server. This type of certificate is stored in a |
| 5362 |
16 Jun 10 |
nicklas |
786 |
<emphasis>key-store</emphasis>. By default, no key-store is setup. |
| 5362 |
16 Jun 10 |
nicklas |
787 |
</para> |
| 5362 |
16 Jun 10 |
nicklas |
788 |
|
| 5362 |
16 Jun 10 |
nicklas |
789 |
<para> |
| 5336 |
04 May 10 |
nicklas |
790 |
If all you need is to support servers with self-signed certificates we |
| 5336 |
04 May 10 |
nicklas |
791 |
recommend that those certificates are imported to the above mentioned file. |
| 5336 |
04 May 10 |
nicklas |
792 |
No configuration changes are needed. If a key-store is needed, you must also |
| 5336 |
04 May 10 |
nicklas |
793 |
configure the trust-store. Read the <ulink |
| 5336 |
04 May 10 |
nicklas |
794 |
url="http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html" |
| 5336 |
04 May 10 |
nicklas |
795 |
>Java Secure Socket Extension Reference Guide</ulink> for more information about Java |
| 5336 |
04 May 10 |
nicklas |
796 |
security and SSL. Java ships with a certificate management tool that can be used |
| 5336 |
04 May 10 |
nicklas |
797 |
to manage certificate files and a lot of other things. The |
| 5336 |
04 May 10 |
nicklas |
798 |
<ulink url="http://java.sun.com/javase/6/docs/technotes/tools/windows/keytool.html" |
| 5336 |
04 May 10 |
nicklas |
799 |
>keytool - Key and Certificate Management Tool</ulink> document contains more information |
| 5336 |
04 May 10 |
nicklas |
800 |
about this tool. |
| 5336 |
04 May 10 |
nicklas |
801 |
</para> |
| 5336 |
04 May 10 |
nicklas |
802 |
|
| 5337 |
05 May 10 |
nicklas |
803 |
<para> |
| 5337 |
05 May 10 |
nicklas |
804 |
If you want to setup your own test environment with a https server that only |
| 5337 |
05 May 10 |
nicklas |
805 |
accepts clients with a trusted certificate you can find some information about |
| 7982 |
14 Jun 21 |
nicklas |
806 |
this on our wiki: <ulink url="https://base.thep.lu.se/wiki/HttpsFiles" |
| 7982 |
14 Jun 21 |
nicklas |
807 |
>https://base.thep.lu.se/wiki/HttpsFiles</ulink> |
| 5337 |
05 May 10 |
nicklas |
808 |
</para> |
| 5337 |
05 May 10 |
nicklas |
809 |
|
| 5336 |
04 May 10 |
nicklas |
810 |
<variablelist> |
| 5336 |
04 May 10 |
nicklas |
811 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
812 |
<term><property>ssl.context.protocol</property></term> |
| 5336 |
04 May 10 |
nicklas |
813 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
814 |
<para> |
| 5336 |
04 May 10 |
nicklas |
815 |
The SSL protocol to use. The default value is TLS. |
| 5336 |
04 May 10 |
nicklas |
816 |
</para> |
| 5336 |
04 May 10 |
nicklas |
817 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
818 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
819 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
820 |
<term><property>ssl.context.provider</property></term> |
| 5336 |
04 May 10 |
nicklas |
821 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
822 |
<para> |
| 5336 |
04 May 10 |
nicklas |
823 |
A security provider implementation. If not specified a suitable default is |
| 5336 |
04 May 10 |
nicklas |
824 |
selected. |
| 5336 |
04 May 10 |
nicklas |
825 |
</para> |
| 5336 |
04 May 10 |
nicklas |
826 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
827 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
828 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
829 |
<term><property>ssl.keystore.file</property></term> |
| 5336 |
04 May 10 |
nicklas |
830 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
831 |
<para> |
| 5336 |
04 May 10 |
nicklas |
832 |
The full path to a key-store file. If not specified no key-store is used. |
| 5336 |
04 May 10 |
nicklas |
833 |
</para> |
| 5336 |
04 May 10 |
nicklas |
834 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
835 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
836 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
837 |
<term><property>ssl.keystore.password</property></term> |
| 5336 |
04 May 10 |
nicklas |
838 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
839 |
<para> |
| 5336 |
04 May 10 |
nicklas |
840 |
The password for unlocking the keys in the key-store. All keys must use |
| 5336 |
04 May 10 |
nicklas |
841 |
the same password. |
| 5336 |
04 May 10 |
nicklas |
842 |
</para> |
| 5336 |
04 May 10 |
nicklas |
843 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
844 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
845 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
846 |
<term><property>ssl.keystore.type</property></term> |
| 5336 |
04 May 10 |
nicklas |
847 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
848 |
<para> |
| 5336 |
04 May 10 |
nicklas |
849 |
The file type of the key-store file. The default value is 'JKS'. |
| 5336 |
04 May 10 |
nicklas |
850 |
</para> |
| 5336 |
04 May 10 |
nicklas |
851 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
852 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
853 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
854 |
<term><property>ssl.keystore.provider</property></term> |
| 5336 |
04 May 10 |
nicklas |
855 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
856 |
<para> |
| 5336 |
04 May 10 |
nicklas |
857 |
The name of a provider implementation to use for reading the key-store file. |
| 5336 |
04 May 10 |
nicklas |
858 |
If not specified a suitable default is used. |
| 5336 |
04 May 10 |
nicklas |
859 |
</para> |
| 5336 |
04 May 10 |
nicklas |
860 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
861 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
862 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
863 |
<term><property>ssl.keystore.algorithm</property></term> |
| 5336 |
04 May 10 |
nicklas |
864 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
865 |
<para> |
| 5336 |
04 May 10 |
nicklas |
866 |
The algorithm used in the key-store file. The default value is |
| 5336 |
04 May 10 |
nicklas |
867 |
'SunX509'. |
| 5336 |
04 May 10 |
nicklas |
868 |
</para> |
| 5336 |
04 May 10 |
nicklas |
869 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
870 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
871 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
872 |
<term><property>ssl.truststore.file</property></term> |
| 5336 |
04 May 10 |
nicklas |
873 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
874 |
<para> |
| 5362 |
16 Jun 10 |
nicklas |
875 |
The full path to a trust-store certificate file. If not specified |
| 5362 |
16 Jun 10 |
nicklas |
876 |
the default depends on the key-store setting. If no key-store is |
| 5362 |
16 Jun 10 |
nicklas |
877 |
configured, the default trust-store is used. If a key-store has |
| 5362 |
16 Jun 10 |
nicklas |
878 |
been configured no trust-store is used. |
| 5336 |
04 May 10 |
nicklas |
879 |
</para> |
| 5336 |
04 May 10 |
nicklas |
880 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
881 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
882 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
883 |
<term><property>ssl.truststore.password</property></term> |
| 5336 |
04 May 10 |
nicklas |
884 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
885 |
<para> |
| 5336 |
04 May 10 |
nicklas |
886 |
The password for unlocking the certificates in the trust-store. All certificates |
| 5336 |
04 May 10 |
nicklas |
887 |
must use the same password. |
| 5336 |
04 May 10 |
nicklas |
888 |
</para> |
| 5336 |
04 May 10 |
nicklas |
889 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
890 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
891 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
892 |
<term><property>ssl.truststore.type</property></term> |
| 5336 |
04 May 10 |
nicklas |
893 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
894 |
<para> |
| 5336 |
04 May 10 |
nicklas |
895 |
The file type of the trust-store file. The default value is 'JKS'. |
| 5336 |
04 May 10 |
nicklas |
896 |
</para> |
| 5336 |
04 May 10 |
nicklas |
897 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
898 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
899 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
900 |
<term><property>ssl.truststore.provider</property></term> |
| 5336 |
04 May 10 |
nicklas |
901 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
902 |
<para> |
| 5336 |
04 May 10 |
nicklas |
903 |
The name of a provider implementation to use for reading the trust-store file. |
| 5336 |
04 May 10 |
nicklas |
904 |
If not specified a suitable default is used. |
| 5336 |
04 May 10 |
nicklas |
905 |
</para> |
| 5336 |
04 May 10 |
nicklas |
906 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
907 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
908 |
<varlistentry> |
| 5336 |
04 May 10 |
nicklas |
909 |
<term><property>ssl.truststore.algorithm</property></term> |
| 5336 |
04 May 10 |
nicklas |
910 |
<listitem> |
| 5336 |
04 May 10 |
nicklas |
911 |
<para> |
| 5336 |
04 May 10 |
nicklas |
912 |
The algorithm used in the trust-store file. The default value is |
| 5336 |
04 May 10 |
nicklas |
913 |
'PKIX'. |
| 5336 |
04 May 10 |
nicklas |
914 |
</para> |
| 5336 |
04 May 10 |
nicklas |
915 |
</listitem> |
| 5336 |
04 May 10 |
nicklas |
916 |
</varlistentry> |
| 5336 |
04 May 10 |
nicklas |
917 |
</variablelist> |
| 5336 |
04 May 10 |
nicklas |
918 |
|
| 5336 |
04 May 10 |
nicklas |
919 |
</simplesect> |
| 5895 |
30 Nov 11 |
nicklas |
920 |
|
| 5895 |
30 Nov 11 |
nicklas |
921 |
<simplesect id="appendix.base.config.migrate"> |
| 5895 |
30 Nov 11 |
nicklas |
922 |
<title>Migration section</title> |
| 5895 |
30 Nov 11 |
nicklas |
923 |
|
| 5895 |
30 Nov 11 |
nicklas |
924 |
<para> |
| 5895 |
30 Nov 11 |
nicklas |
925 |
The settings in this section only affect the migration program that can |
| 5895 |
30 Nov 11 |
nicklas |
926 |
be used to move a BASE installation from a MySQL database to PostgreSQL. |
| 5895 |
30 Nov 11 |
nicklas |
927 |
For more information about this see <xref linkend="installation.migrate" />. |
| 5895 |
30 Nov 11 |
nicklas |
928 |
</para> |
| 5895 |
30 Nov 11 |
nicklas |
929 |
|
| 5895 |
30 Nov 11 |
nicklas |
930 |
<variablelist> |
| 5895 |
30 Nov 11 |
nicklas |
931 |
<varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
932 |
<term><property>migrate.export.compress</property></term> |
| 5895 |
30 Nov 11 |
nicklas |
933 |
<listitem> |
| 5895 |
30 Nov 11 |
nicklas |
934 |
<para> |
| 5895 |
30 Nov 11 |
nicklas |
935 |
Enable this option |
| 5895 |
30 Nov 11 |
nicklas |
936 |
to compress the data files generated by the export. This may |
| 5895 |
30 Nov 11 |
nicklas |
937 |
improve performance in case disk speed is a limiting factor. |
| 5895 |
30 Nov 11 |
nicklas |
938 |
Default is to not compress. |
| 5895 |
30 Nov 11 |
nicklas |
939 |
</para> |
| 5895 |
30 Nov 11 |
nicklas |
940 |
</listitem> |
| 5895 |
30 Nov 11 |
nicklas |
941 |
</varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
942 |
<varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
943 |
<term><property>migrate.export.fetch-size</property></term> |
| 5895 |
30 Nov 11 |
nicklas |
944 |
<listitem> |
| 5895 |
30 Nov 11 |
nicklas |
945 |
<para> |
| 5895 |
30 Nov 11 |
nicklas |
946 |
The number |
| 5895 |
30 Nov 11 |
nicklas |
947 |
of rows that should be fetch at the same time from the database. |
| 5895 |
30 Nov 11 |
nicklas |
948 |
A higher value may increase the performance but uses more |
| 5895 |
30 Nov 11 |
nicklas |
949 |
memory. The default value is 20000. |
| 5895 |
30 Nov 11 |
nicklas |
950 |
</para> |
| 5895 |
30 Nov 11 |
nicklas |
951 |
</listitem> |
| 5895 |
30 Nov 11 |
nicklas |
952 |
</varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
953 |
<varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
954 |
<term><property>migrate.import.analyze</property></term> |
| 5895 |
30 Nov 11 |
nicklas |
955 |
<listitem> |
| 5895 |
30 Nov 11 |
nicklas |
956 |
<para> |
| 5895 |
30 Nov 11 |
nicklas |
957 |
Enable this flag to issue an SQL statment for statistical |
| 5895 |
30 Nov 11 |
nicklas |
958 |
analysis of the imported data before continuing with the next |
| 5895 |
30 Nov 11 |
nicklas |
959 |
table. Disabling this may result in very poor performance. This |
| 5895 |
30 Nov 11 |
nicklas |
960 |
option is enabled by default. |
| 5895 |
30 Nov 11 |
nicklas |
961 |
</para> |
| 5895 |
30 Nov 11 |
nicklas |
962 |
</listitem> |
| 5895 |
30 Nov 11 |
nicklas |
963 |
</varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
964 |
|
| 5895 |
30 Nov 11 |
nicklas |
965 |
<varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
966 |
<term><property>migrate.import.drop-primary-key</property></term> |
| 5895 |
30 Nov 11 |
nicklas |
967 |
<listitem> |
| 5895 |
30 Nov 11 |
nicklas |
968 |
<para> |
| 5895 |
30 Nov 11 |
nicklas |
969 |
Enable this flag to drop the primary key of a table before |
| 5895 |
30 Nov 11 |
nicklas |
970 |
importing data to it. This may increase the performance. The |
| 5895 |
30 Nov 11 |
nicklas |
971 |
primary key is re-created after the data has been imported. |
| 5895 |
30 Nov 11 |
nicklas |
972 |
This option is enabled by default. |
| 5895 |
30 Nov 11 |
nicklas |
973 |
</para> |
| 5895 |
30 Nov 11 |
nicklas |
974 |
</listitem> |
| 5895 |
30 Nov 11 |
nicklas |
975 |
</varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
976 |
|
| 5895 |
30 Nov 11 |
nicklas |
977 |
<varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
978 |
<term><property>migrate.import.drop-constraints</property></term> |
| 5895 |
30 Nov 11 |
nicklas |
979 |
<listitem> |
| 5895 |
30 Nov 11 |
nicklas |
980 |
<para> |
| 5895 |
30 Nov 11 |
nicklas |
981 |
Enable this flag to drop unique constraints and indexes before |
| 5895 |
30 Nov 11 |
nicklas |
982 |
importing data to a table. This may increase the performance. |
| 5895 |
30 Nov 11 |
nicklas |
983 |
The constraints and indexes are re-created after the data has been |
| 5895 |
30 Nov 11 |
nicklas |
984 |
imported. NOTE! Foreign key constraints are not affected by this flag, |
| 5895 |
30 Nov 11 |
nicklas |
985 |
since they must always be dropped. This option is enabled by |
| 5895 |
30 Nov 11 |
nicklas |
986 |
default. |
| 5895 |
30 Nov 11 |
nicklas |
987 |
</para> |
| 5895 |
30 Nov 11 |
nicklas |
988 |
</listitem> |
| 5895 |
30 Nov 11 |
nicklas |
989 |
</varlistentry> |
| 5895 |
30 Nov 11 |
nicklas |
990 |
</variablelist> |
| 5895 |
30 Nov 11 |
nicklas |
991 |
|
| 5895 |
30 Nov 11 |
nicklas |
992 |
</simplesect> |
| 5336 |
04 May 10 |
nicklas |
993 |
|
| 3334 |
14 May 07 |
nicklas |
994 |
</appendix> |
| 3334 |
14 May 07 |
nicklas |
995 |
|