README

   1 About OpenERP
   2 -------------
   3
   4 OpenERP is a free Enterprise Resource Planning and Customer Relationship
   5 Management software. It is mainly developed to meet changing needs.
   6
   7 The main functional features are: CRM & SRM, analytic and financial accounting,
   8 double-entry stock management, sales and purchases management, tasks automation,
   9 help desk, marketing campaign, ... and vertical modules for very specific
  10 businesses.
  11
  12 Technical features include a distributed server, flexible workflows, an object
  13 database, dynamic GUIs, customizable reports, NET-RPC and XML-RPC interfaces, ...
  14
  15 For more information, please visit:
  16 http://www.openerp.com
  17
  18 OpenERP Quick Installation Guide
  19 ---------------------------------
  20
  21 This file contains a quick guide to configure and install the OpenERP server.
  22
  23 Required dependencies:
  24 ---------------------
  25
  26 You need the following software installed:
  27
  28     * Python 2.5 or 2.6
  29     * Postgresql 8.2 or above
  30     * Psycopg2 python module
  31     * Reportlab pdf generation library for python
  32     * lxml python module
  33     * pytz python module
  34     * PyYaml python module (install with: easy_install PyYaml)
  35
  36 Some dependencies are only required for specific purposes:
  37
  38 for rendering workflows graphs, you need:
  39     * graphviz
  40     * pyparsing
  41
  42 For Luxembourg localization, you also need:
  43     * pdftk (http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/)
  44
  45 for generating reports using non .jpg images, you need:
  46     * Python Imaging Library for python
  47
  48 For Debian-based distributions, the required packages can be installed with the
  49 following command:
  50
  51   #> apt-get install -y postgresql graphviz python-psycopg2 python-lxml python-tz python-imaging
  52
  53 For Fedora
  54 if they are not installed, install:
  55 python and postgresql
  56
  57 uses yum or you can recover required packages on fedora web site in "core" or "extra" repository :
  58 postgresql-python
  59 python-lxml
  60 python-imaging
  61 python-psycopg2
  62 python-reportlab
  63 graphviz
  64 You can find pyparsing at http://pyparsing.sourceforge.net/
  65
  66 1. Check that all the required dependencies are installed.
  67
  68 2. Launch the program "python ./bin/openerp-server.py -r db_user -w db_password --db_host 127.0.0.1".
  69 See the man page for more information about options.
  70
  71 3. Connect to the server using the GUI client. And follow the instructions to create a new database.
  72
  73 Installation Steps
  74 ------------------
  75
  76 1. Check that all the required dependencies are installed.
  77
  78 2. Create a postgresql database.
  79
  80 The default database name is "terp". If you want to use another name, you
  81 will need to provide it when launching the server (by using the commandline
  82 option --database).
  83
  84 To create a postgresql database named "terp" using the following command:
  85     $ createdb --encoding=UNICODE terp
  86
  87 If it is the first time you use postgresql you might need to create a new user
  88 to the postgres system using the following commands (where myusername is your
  89 unix user name):
  90
  91     $ su -
  92     # su - postgres
  93     $ createuser openerp
  94     Shall the new user be allowed to create databases? (y/n) y
  95     Shall the new user be allowed to create more new users? (y/n) y
  96     CREATE USER
  97     $ logout
  98     # logout
  99
 100 3. Launch service daemon by "service openerp-server start".
 101
 102 The first time it is run, the server will initialise the database with all the default values.
 103
 104 4. Connect to the server using the GUI client.
 105
 106 There are two accounts by default:
 107     * login: admin, password:admin
 108     * login: demo, password:demo
 109
 110 Some instructions to use setup.py for a user-install.
 111 This file should/will be moved on a proper documentation place later.
 112
 113
 114 - Possibly clean any left-over of the previous build.
 115   > rm -rf dist openerp_server.egg-info
 116
 117 - Possibly copy the addons in the server if we want them to be packaged
 118   together:
 119   > rsync -av --delete \
 120     --exclude .bzr/ \
 121     --exclude .bzrignore \
 122     --exclude /__init__.py \
 123     --exclude /base \
 124     --exclude /base_quality_interrogation.py \
 125     <path-to-addons> openerp/addons
 126
 127 - Create the user-local directory where we want the package to be installed:
 128    > mkdir -p /home/openerp/openerp-tmp/lib/python2.6/site-packages/
 129
 130 - Use --prefix to specify where the package is installed and include that
 131   place in PYTHONPATH:
 132   > PYTHONPATH=/home/openerp/openerp-tmp/lib/python2.6/site-packages/ \
 133     python setup.py install --prefix=/home/openerp/openerp-tmp
 134
 135 - Run the main script, again specifying the PYTHONPATH:
 136   > PYTHONPATH=/home/openerp/openerp-tmp/lib/python2.6/site-packages/ \
 137     /home/openerp/openerp-tmp/bin/openerp-server
 138