2
.. i18n: .. _configuration-files-link:
8
.. _configuration-files-link:
13
.. i18n: Two configuration files are available:
16
Two configuration files are available:
18
.. i18n: * one for the client: ~/.openerprc
19
.. i18n: * one for the server: ~/.openerp_serverrc
22
* one for the client: ~/.openerprc
23
* one for the server: ~/.openerp_serverrc
25
.. i18n: Those files follow the convention used by python's ConfigParser module.
28
Those files follow the convention used by python's ConfigParser module.
30
.. i18n: Lines beginning with "#" or ";" are comments.
33
Lines beginning with "#" or ";" are comments.
35
.. i18n: The client configuration file is automatically generated upon the first start. The one of the server can automatically be created using the command: ::
37
.. i18n: openerp-server.py -s
40
The client configuration file is automatically generated upon the first start. The one of the server can automatically be created using the command: ::
44
.. i18n: If they are not found, the server and the client will start with the default configuration.
47
If they are not found, the server and the client will start with the default configuration.
49
.. i18n: Server Configuration File
50
.. i18n: -------------------------
53
Server Configuration File
54
-------------------------
56
.. i18n: The server configuration file .openerp_serverrc is used to save server startup options. Here is the list of the available options:
59
The server configuration file .openerp_serverrc is used to save server startup options. Here is the list of the available options:
62
.. i18n: Address to which the server will be bound
66
Address to which the server will be bound
69
.. i18n: Port the server will listen on
73
Port the server will listen on
76
.. i18n: Name of the database to use
80
Name of the database to use
83
.. i18n: Username used when connecting to the database
87
Username used when connecting to the database
89
.. i18n: :translate_in:
90
.. i18n: File used to translate OpenERP to your language
94
File used to translate OpenERP to your language
96
.. i18n: :translate_out:
97
.. i18n: File used to export the language OpenERP use
101
File used to export the language OpenERP use
104
.. i18n: Use this language as the language of the server. This must be specified as an ISO country code, as specified by the W3C.
108
Use this language as the language of the server. This must be specified as an ISO country code, as specified by the W3C.
111
.. i18n: Enable debug output
118
.. i18n: init a module (use "all" for all modules)
122
init a module (use "all" for all modules)
125
.. i18n: update a module (use "all" for all modules)
129
update a module (use "all" for all modules)
132
.. i18n: Upgrade/install/uninstall modules
136
Upgrade/install/uninstall modules
139
.. i18n: specify the database name
143
specify the database name
146
.. i18n: specify the database user name
150
specify the database user name
152
.. i18n: :db_password:
153
.. i18n: specify the database password
157
specify the database password
160
.. i18n: specify the pg executable path
164
specify the pg executable path
167
.. i18n: specify the database host
171
specify the database host
174
.. i18n: specify the database port
178
specify the database port
180
.. i18n: :translate_modules:
181
.. i18n: Specify modules to export. Use in combination with --i18n-export
185
Specify modules to export. Use in combination with --i18n-export
187
.. i18n: You can create your own configuration file by specifying -s or --save on the server command line. If you would like to write an alternative configuration file, use -c <config file> or --config=<config file>
188
.. i18n: Here is a basic configuration for a server::
191
.. i18n: verbose = False
192
.. i18n: xmlrpc = True
193
.. i18n: database = terp
197
.. i18n: interface = 127.0.0.1
198
.. i18n: reportgz = False
201
You can create your own configuration file by specifying -s or --save on the server command line. If you would like to write an alternative configuration file, use -c <config file> or --config=<config file>
202
Here is a basic configuration for a server::
211
interface = 127.0.0.1
214
.. i18n: Full Example for Server V5.0 ::
218
.. i18n: softpath_html = none
219
.. i18n: preview = True
220
.. i18n: softpath = none
223
.. i18n: output = stdout
225
.. i18n: verbose = True
226
.. i18n: level = error
229
.. i18n: index = http://www.openerp.com/documentation/user-manual/
230
.. i18n: context = http://www.openerp.com/scripts/context_index.php
233
.. i18n: autosave = False
234
.. i18n: toolbar = True
237
.. i18n: recipient = support@openerp.com
238
.. i18n: support_id =
241
.. i18n: position = 0
242
.. i18n: autostart = False
245
.. i18n: lang = en_US
246
.. i18n: default_path = /home/user
247
.. i18n: filetype = {}
248
.. i18n: theme = none
249
.. i18n: toolbar = icons
250
.. i18n: form_tab_orientation = 0
251
.. i18n: form_tab = top
254
.. i18n: position = 3
257
.. i18n: pixmaps = /usr/share/pixmaps/openerp-client/
258
.. i18n: share = /usr/share/openerp-client/
262
.. i18n: login = admin
263
.. i18n: protocol = http://
265
.. i18n: server = localhost
268
Full Example for Server V5.0 ::
283
index = http://www.openerp.com/documentation/user-manual/
284
context = http://www.openerp.com/scripts/context_index.php
291
recipient = support@openerp.com
300
default_path = /home/user
304
form_tab_orientation = 0
311
pixmaps = /usr/share/pixmaps/openerp-client/
312
share = /usr/share/openerp-client/
321
.. i18n: GTK-Client Configuration
322
.. i18n: ------------------------
325
GTK-Client Configuration
326
------------------------
328
.. i18n: .. topic:: login section
331
.. i18n: login name to use to connect to OpenERP server
334
.. i18n: address used by the server
337
.. i18n: port used by the server
340
.. topic:: login section
343
login name to use to connect to OpenERP server
346
address used by the server
349
port used by the server
351
.. i18n: .. topic:: path section
354
.. i18n: path used to find OpenERP shared files
357
.. i18n: path used to find OpenERP pixmaps files
360
.. topic:: path section
363
path used to find OpenERP shared files
366
path used to find OpenERP pixmaps files
368
.. i18n: .. topic:: tip section
371
.. i18n: Should the client display tips at startup
374
.. i18n: Tip number the client will display
377
.. topic:: tip section
380
Should the client display tips at startup
383
Tip number the client will display
385
.. i18n: .. topic:: form section
388
.. i18n: The client will automatically save the change you made to a record
391
.. topic:: form section
394
The client will automatically save the change you made to a record
396
.. i18n: .. topic:: printer section
399
.. i18n: Preview report before printing
402
.. i18n: Path to the pdf previewer
404
.. i18n: :softpath_html:
405
.. i18n: Path to the html previewer
408
.. i18n: Command used to print
411
.. topic:: printer section
414
Preview report before printing
417
Path to the pdf previewer
420
Path to the html previewer
423
Command used to print
425
.. i18n: .. topic:: logging section
428
.. i18n: log channels to display. List values are: @common@, @common.message@, @view@, @view.form@, @common.options@, @rpc.request@, @rpc.result@, @rpc.exception@
431
.. i18n: logging level to show
434
.. i18n: file used by the logger
437
.. i18n: set the log level to INFO
440
.. topic:: logging section
443
log channels to display. List values are: @common@, @common.message@, @view@, @view.form@, @common.options@, @rpc.request@, @rpc.result@, @rpc.exception@
446
logging level to show
449
file used by the logger
452
set the log level to INFO
454
.. i18n: .. topic:: client section
456
.. i18n: :default_path:
457
.. i18n: Default path used by the client when saving/loading datas.
460
.. topic:: client section
463
Default path used by the client when saving/loading datas.
465
.. i18n: **Default values**::
468
.. i18n: login = admin
470
.. i18n: server = 192.168.1.4
474
.. i18n: preview = True
475
.. i18n: softpath = none
478
.. i18n: output = stdout
480
.. i18n: verbose = True
481
.. i18n: level = ERROR
484
.. i18n: autosave = False
487
.. i18n: default_path = /home/user
512
default_path = /home/user
514
.. i18n: Web Client Configuration
515
.. i18n: ------------------------
518
Web Client Configuration
519
------------------------
521
.. i18n: Full Example for web Client Configuration ::
524
.. i18n: # Some server parameters that you may want to tweak
525
.. i18n: server.socket_host = "0.0.0.0"
526
.. i18n: server.socket_port = 8080
528
.. i18n: # Sets the number of threads the server uses
529
.. i18n: server.thread_pool = 10
531
.. i18n: server.environment = "development"
533
.. i18n: # Simple code profiling
534
.. i18n: server.profile_on = False
535
.. i18n: server.profile_dir = "profile"
537
.. i18n: # if this is part of a larger site, you can set the path to the TurboGears instance here
538
.. i18n: server.webpath = ""
541
.. i18n: #log.access_file = "/var/log/openerp-web/access.log"
542
.. i18n: #log.error_file = "/var/log/openerp-web/error.log"
544
.. i18n: # OpenERP Server
546
.. i18n: host = 'localhost'
547
.. i18n: port = '8070'
548
.. i18n: protocol = 'socket'
550
.. i18n: # Web client settings
551
.. i18n: [openerp-web]
552
.. i18n: # filter dblists based on url pattern?
553
.. i18n: # NONE: No Filter
554
.. i18n: # EXACT: Exact Hostname
555
.. i18n: # UNDERSCORE: Hostname_
556
.. i18n: # BOTH: Exact Hostname or Hostname_
558
.. i18n: dblist.filter = 'NONE'
560
.. i18n: # whether to show Databases button on Login screen or not
561
.. i18n: dbbutton.visible = True
563
.. i18n: # will be applied on company logo
564
.. i18n: company.url = ''
566
.. i18n: # options to limit data rows in M2M/O2M lists, will be overriden
567
.. i18n: # with limit="5", min_rows="5" attributes in the tree view definitions
568
.. i18n: child.listgrid.limit = 5
569
.. i18n: child.listgrid.min_rows = 5
572
Full Example for web Client Configuration ::
575
# Some server parameters that you may want to tweak
576
server.socket_host = "0.0.0.0"
577
server.socket_port = 8080
579
# Sets the number of threads the server uses
580
server.thread_pool = 10
582
server.environment = "development"
584
# Simple code profiling
585
server.profile_on = False
586
server.profile_dir = "profile"
588
# if this is part of a larger site, you can set the path to the TurboGears instance here
592
#log.access_file = "/var/log/openerp-web/access.log"
593
#log.error_file = "/var/log/openerp-web/error.log"
601
# Web client settings
603
# filter dblists based on url pattern?
605
# EXACT: Exact Hostname
606
# UNDERSCORE: Hostname_
607
# BOTH: Exact Hostname or Hostname_
609
dblist.filter = 'NONE'
611
# whether to show Databases button on Login screen or not
612
dbbutton.visible = True
614
# will be applied on company logo
617
# options to limit data rows in M2M/O2M lists, will be overriden
618
# with limit="5", min_rows="5" attributes in the tree view definitions
619
child.listgrid.limit = 5
620
child.listgrid.min_rows = 5
622
.. i18n: Get a clone of each repository::
624
.. i18n: bzr clone lp:~openerp/openobject-server/trunk server
625
.. i18n: bzr clone lp:~openerp/openobject-client/trunk client
626
.. i18n: bzr clone lp:~openerp/openobject-client-web/trunk client-web
627
.. i18n: bzr clone lp:~openerp/openobject-addons/trunk addons
630
Get a clone of each repository::
632
bzr clone lp:~openerp/openobject-server/trunk server
633
bzr clone lp:~openerp/openobject-client/trunk client
634
bzr clone lp:~openerp/openobject-client-web/trunk client-web
635
bzr clone lp:~openerp/openobject-addons/trunk addons
637
.. i18n: If you want to get a clone of the extra-addons repository, you can execute this command::
639
.. i18n: bzr clone lp:~openerp-commiter/openobject-addons/trunk-extra-addons extra-addons
642
If you want to get a clone of the extra-addons repository, you can execute this command::
644
bzr clone lp:~openerp-commiter/openobject-addons/trunk-extra-addons extra-addons
646
.. i18n: run the setup scripts in the respective directories::
648
.. i18n: python2.5 setup.py build
649
.. i18n: sudo python2.5 setup.py install
652
run the setup scripts in the respective directories::
654
python2.5 setup.py build
655
sudo python2.5 setup.py install
657
.. i18n: Currently the initialisation procedure of the server parameter --init=all to
658
.. i18n: populate the database seems to be broken in trunk.
661
Currently the initialisation procedure of the server parameter --init=all to
662
populate the database seems to be broken in trunk.
664
.. i18n: It is recommended to create a new database via the gtk-client. Before that the web-client will not work.
667
It is recommended to create a new database via the gtk-client. Before that the web-client will not work.
669
.. i18n: Start OpenERP server like this: ::
671
.. i18n: ./openerp-server.py --addons-path=~/home/workspace/stable/addons
674
Start OpenERP server like this: ::
676
./openerp-server.py --addons-path=~/home/workspace/stable/addons
678
.. i18n: The ``bin/addons`` will be considered as default addons directory which can be
679
.. i18n: overriden by the ``~/home/workspace/stable/addons``. That is if an addon exists in
680
.. i18n: ``bin/addons`` as well as ``~/home/workspace/stable/addons`` (custom path) the later one will
681
.. i18n: be given preference over the ``bin/addons`` (default path).
684
The ``bin/addons`` will be considered as default addons directory which can be
685
overriden by the ``~/home/workspace/stable/addons``. That is if an addon exists in
686
``bin/addons`` as well as ``~/home/workspace/stable/addons`` (custom path) the later one will
687
be given preference over the ``bin/addons`` (default path).