[IMP] README cleanups

bzr revid: al@openerp.com-20111006001218-uzsqgl8ilkndxfr0
This commit is contained in:
Antony Lesuisse 2011-10-06 02:12:18 +02:00
parent e29e8f80de
commit 527fe0ff65
4 changed files with 42 additions and 174 deletions

163
README
View File

@ -1,138 +1,55 @@
About OpenERP
-------------
OpenERP is a free Enterprise Resource Planning and Customer Relationship
Management software. It is mainly developed to meet changing needs.
OpenERP is an OpenSrouce/Free software Enterprise Resource Planning and
Customer Relationship Management software. More info at:
The main functional features are: CRM & SRM, analytic and financial accounting,
double-entry stock management, sales and purchases management, tasks automation,
help desk, marketing campaign, ... and vertical modules for very specific
businesses.
http://www.openerp.com
Technical features include a distributed server, flexible workflows, an object
database, dynamic GUIs, customizable reports, NET-RPC and XML-RPC interfaces, ...
Installation on Debian Ubuntu
-----------------------------
For more information, please visit:
http://www.openerp.com
Add the the apt repository in your source.list and type:
OpenERP Quick Installation Guide
---------------------------------
$ apt-get install openerp
This file contains a quick guide to configure and install the OpenERP server.
Installation on RedHat, Fedora, CentOS
--------------------------------------
Required dependencies:
---------------------
Install the required dependencies:
$ yum install python
$ easy_install pip
$ pip install .....
Install the openerp rpm
$ rpm -i openerp-VERSION.rpm
Installation on Windows
-----------------------
Installation on MacOSX
-----------------------
Setuping you first database
---------------------------
Point your browser to http://localhost:8069/ and click "Database", the default
master password is "admin".
Detailed System Requirements
----------------------------
You need the following software installed:
* Python 2.5 or 2.6
* Postgresql 8.2 or above
* Psycopg2 python module
* Reportlab pdf generation library for python
* lxml python module
* pytz python module
* PyYaml python module (install with: easy_install PyYaml)
Some dependencies are only required for specific purposes:
for rendering workflows graphs, you need:
* graphviz
* pyparsing
python, postgresql-client, python-dateutil, python-gdata, python-ldap,
python-libxslt1, python-lxml, python-mako, python-openid, python-psycopg2,
python-pybabel, python-pychart, python-pydot, python-pyparsing,
python-reportlab, python-simplejson, python-tz, python-vobject, python-webdav,
python-werkzeug, python-yaml, python-zsi, graphviz, ghostscript, postgresql,
python-imaging, python-matplotlib
For Luxembourg localization, you also need:
* pdftk (http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/)
for generating reports using non .jpg images, you need:
* Python Imaging Library for python
For Debian-based distributions, the required packages can be installed with the
following command:
#> apt-get install -y postgresql graphviz python-psycopg2 python-lxml python-tz python-imaging
For Fedora
if they are not installed, install:
python and postgresql
uses yum or you can recover required packages on fedora web site in "core" or "extra" repository :
postgresql-python
python-lxml
python-imaging
python-psycopg2
python-reportlab
graphviz
You can find pyparsing at http://pyparsing.sourceforge.net/
1. Check that all the required dependencies are installed.
2. Launch the program "python ./bin/openerp-server.py -r db_user -w db_password --db_host 127.0.0.1".
See the man page for more information about options.
3. Connect to the server using the GUI client. And follow the instructions to create a new database.
Installation Steps
------------------
1. Check that all the required dependencies are installed.
2. Create a postgresql database.
The default database name is "terp". If you want to use another name, you
will need to provide it when launching the server (by using the commandline
option --database).
To create a postgresql database named "terp" using the following command:
$ createdb --encoding=UNICODE terp
If it is the first time you use postgresql you might need to create a new user
to the postgres system using the following commands (where myusername is your
unix user name):
$ su -
# su - postgres
$ createuser openerp
Shall the new user be allowed to create databases? (y/n) y
Shall the new user be allowed to create more new users? (y/n) y
CREATE USER
$ logout
# logout
3. Launch service daemon by "service openerp-server start".
The first time it is run, the server will initialise the database with all the default values.
4. Connect to the server using the GUI client.
There are two accounts by default:
* login: admin, password:admin
* login: demo, password:demo
Some instructions to use setup.py for a user-install.
This file should/will be moved on a proper documentation place later.
- Possibly clean any left-over of the previous build.
> rm -rf dist openerp_server.egg-info
- Possibly copy the addons in the server if we want them to be packaged
together:
> rsync -av --delete \
--exclude .bzr/ \
--exclude .bzrignore \
--exclude /__init__.py \
--exclude /base \
--exclude /base_quality_interrogation.py \
<path-to-addons> openerp/addons
- Create the user-local directory where we want the package to be installed:
> mkdir -p /home/openerp/openerp-tmp/lib/python2.6/site-packages/
- Use --prefix to specify where the package is installed and include that
place in PYTHONPATH:
> PYTHONPATH=/home/openerp/openerp-tmp/lib/python2.6/site-packages/ \
python setup.py install --prefix=/home/openerp/openerp-tmp
- Run the main script, again specifying the PYTHONPATH:
> PYTHONPATH=/home/openerp/openerp-tmp/lib/python2.6/site-packages/ \
/home/openerp/openerp-tmp/bin/openerp-server
* pdftk (http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/)

View File

@ -1,49 +0,0 @@
openerp-server for Debian
-------------------------
Open ERP uses a PostgreSQL database to store its data. With the first generation
of packages, you have to setup this database manually. Here is a short
explanation how to achieve this (you need to execute all commands as root):
0. Making sure, PostgreSQL is running
# /etc/init.d/postgresql restart
Note that depending on the version of PostgreSQL installed on your system,
the above syvinit script could also be named postgresql-VERSION (whereas
'VERSION' needs to be replace with a version number).
1. Creating the database user
# su - postgres -c "createuser --createdb --no-createrole --pwprompt openerp"
Note: If you want to run the database as another user than 'openerp', you
need to replace 'openerp' above with the user you want instead, and you
need to adjust 'db_user = openerp' in /etc/openerp-server.conf too.
3. Restarting openerp-server
# /etc/init.d/openerp-server restart
4. Initializing the database
Now you can connect with Open ERP client to the database and initialize it.
Now, you're finish. Please be aware of the following things:
* openerp-server has by default two accounts:
- User: admin; password: admin
- User: demo; password; demo
* openerp-server listens by default on port 8070. If you need to change this,
edit /etc/openerp-server.conf and replace 'port = 8070' with
'port = <your port>'.
* openerp-server in the upstreams configuration listens by default to *all*
interfaces. For security reasons, we do restrict it in the Debian packages
to listen only on localhost. If you need to change this, edit
/etc/openerp-server.conf and replace 'interface = localhost' with
'interface = <your ip>'.
-- Daniel Baumann <daniel@debian.org> Fri, 1 Jun 2007 12:00:00 +0200

View File

@ -1 +1,2 @@
install/openerp-server.conf /etc/openerp
README /usr/share/doc/openerp

3
debian/rules vendored
View File

@ -1,4 +1,5 @@
#!/usr/bin/make -f
# vim:noet:
%:
dh ${@}
@ -11,8 +12,6 @@ override_dh_pysupport:
dh_pysupport
rm -Rf debian/openerp/usr/lib
override_dh_installinit:
dh_installinit --update-rcd-params='defaults 21'