Merge lp:~openerp-groupes/openobject-doc/build_deploy into lp:~openerp-community/openobject-doc/5.0

Proposed by Olivier Ligot
Status: Merged
Merged at revision: 481
Proposed branch: lp:~openerp-groupes/openobject-doc/build_deploy
Merge into: lp:~openerp-community/openobject-doc/5.0
Diff against target: 226 lines (+203/-1)
3 files modified
source/developer/8_24_build/index.rst (+149/-0)
source/developer/8_25_deploy/index.rst (+43/-0)
source/developer/index.rst (+11/-1)
To merge this branch: bzr merge lp:~openerp-groupes/openobject-doc/build_deploy
Reviewer Review Type Date Requested Status
Don Kirkby Approve
Review via email: mp+49087@code.launchpad.net

Description of the change

This branch adds a build on Linux and deploy on Windows part to the documentation.
This process is currently used at Groupe S as we have to deploy on Windows.

To post a comment you must log in.
Revision history for this message
Don Kirkby (donkirkby) wrote :

The formatting looks fine to me and I don't get any documentation build errors. I haven't tried the instructions, but people can add clarifications later if they have problems following.

You know you can commit to the trunk, right? Anybody in the OpenERP Community group can.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== added directory 'source/developer/8_24_build'
=== added file 'source/developer/8_24_build/index.rst'
--- source/developer/8_24_build/index.rst 1970-01-01 00:00:00 +0000
+++ source/developer/8_24_build/index.rst 2011-02-09 16:45:08 +0000
@@ -0,0 +1,149 @@
1
2Build
3=====
4
5This page describes how to build a custom version of OpenERP for Windows.
6
7Dependencies
8------------
9
10The first step is to build the dependences. To do so, grab the Windows installer branch::
11
12 bzr branch lp:~openerp-groupes/openerp/win-installer-trunk
13
14and install the packages:
15
16 * 7z465.msi
17 * python-2.5.2.msi
18 * setuptools-0.6c9.win32-py2.5.exe
19 * Beaker-1.4.1.tar.gz
20 * Mako-0.2.4.tar.gz
21 * pytz-2010l.win32.exe
22
23Server
24++++++
25
26Install the packages:
27
28 * lxml-2.1.2.win32-py2.5.exe
29 * PIL-1.1.6.win32-py2.5.exe
30 * psycopg2-2.2.2.win32-py2.5-pg9.0.1-release.exe
31 * PyChart-1.39.win32.exe
32 * pydot-1.0.2.win32.exe
33 * python-dateutil-1.5.tar.gz
34 * pywin32-212.win32-py2.5.exe
35 * PyYAML-3.09.win32-py2.5.exe
36 * ReportLab-2.2.win32-py2.5.exe
37
38Web
39+++
40
41Install the packages:
42
43 * Babel-0.9.4-py2.5.egg
44 * CherryPy-3.1.2.win32.exe
45 * FormEncode-1.2.2.tar.gz
46 * simplejson-2.0.9-py2.5-win32.egg
47 * xlwt-0.7.2.win32.exe
48
49Source distribution
50-------------------
51
52The second step is to build a source distribution on Linux.
53
54Server
55++++++
56
57Let's assume you work on your own server branch named **6.0** and you want to build a server with the following modules:
58
59 * base_setup
60 * base_tools
61 * board
62
63This implies that these modules have been linked in *bin/addons* by a command similar to::
64
65 ln -s ~/openerp/addons/6.0/{base_setup,base_tools,board} .
66
67To build the server, go to the root directory and type::
68
69 python setup.py sdist --format=zip
70
71You now have a new file in the **dist** directory, called openerp-server-M.m.P.zip where:
72 * **M** is the major version, example 6
73 * **m** is the minor version, example 0
74 * **p** is the patch version, example 1
75
76Web
77+++
78
79To build the web client, go to the root directory and type::
80
81 python setup.py sdist --format=zip
82
83You now have a new file in the **dist** directory, called openerp-web-M.m.P.zip where:
84 * **M** is the major version, example 6
85 * **m** is the minor version, example 0
86 * **p** is the patch version, example 1
87
88Binary distribution
89-------------------
90
91The third step is to build a binary distribution on Windows.
92
93Server
94++++++
95
96Open a command prompt and unzip the file::
97
98 7z x openerp-server-M.m.P.zip -oC:\openerp
99
100Go to the **win32** directory::
101
102 cd C:\openerp\openerp-server-M.m.P\win32
103
104Generate the service exe with::
105
106 python setup.py py2exe
107
108Go to the parent directory::
109
110 cd ..
111
112Generate the server exe with::
113
114 python setup.py py2exe
115
116Build the Windows installer with::
117
118 makensis setup.nsi
119
120You now have a new file in the root directory, called openerp-server-setup-M.m.P.exe. This file is the installer that you can use the install a custom version of OpenERP.
121
122Web
123+++
124
125Open a command prompt and unzip the file::
126
127 7z x openerp-web-M.m.P.zip -oC:\openerp
128
129Go to the **win32** directory::
130
131 cd C:\openerp\openerp-web-M.m.P\win32
132
133Generate the service exe with::
134
135 python setup.py py2exe
136
137Go to the parent directory::
138
139 cd ..
140
141Generate the web exe with::
142
143 python setup.py py2exe
144
145Build the Windows installer with::
146
147 makensis setup.nsi
148
149You now have a new file in the root directory, called openerp-web-setup-M.m.P.exe. This file is the installer that you can use the install a custom version of OpenERP.
0150
=== added directory 'source/developer/8_25_deploy'
=== added file 'source/developer/8_25_deploy/index.rst'
--- source/developer/8_25_deploy/index.rst 1970-01-01 00:00:00 +0000
+++ source/developer/8_25_deploy/index.rst 2011-02-09 16:45:08 +0000
@@ -0,0 +1,43 @@
1
2Deploy
3======
4
5This page describes how to deploy a custom version of OpenERP on Windows.
6
7Package script
8--------------
9
10The first step is to grab the package script branch::
11
12 bzr branch lp:~openerp-groupes/openerp/package-script
13
14Batch
15-----
16
17Go to the *packaging* directory of the branch and copy the file *build.bat* to the *C:\\openerp* directory of your Windows machine.
18
19SSH server
20----------
21
22You need to install a SSH server on Windows. You can for example install `freeSSHd <http://www.freesshd.com/>`_.
23
24Fabric
25------
26
27You need to install the tool `Fabric <http://docs.fabfile.org/0.9.3/>`_ to run commands on Windows from Linux using SSH. Refer to your linux package manager to install it.
28
29Configure
30+++++++++
31
32Go to the *packaging* directory of the branch and edit the file fabfile.py. Change what need to be changed.
33
34Run
35+++
36
37run the command::
38
39 fab -H host -u user server
40
41where:
42 * *host* is the Windows host name
43 * *user* is the Windows user name
044
=== modified file 'source/developer/index.rst'
--- source/developer/index.rst 2010-12-31 00:03:27 +0000
+++ source/developer/index.rst 2011-02-09 16:45:08 +0000
@@ -86,7 +86,17 @@
86 Miscellaneous/index86 Miscellaneous/index
8787
8888
89Part 8 : Appendices89Part 8 : Build and deploy
90-------------------------
91
92.. toctree::
93 :maxdepth: 2
94
95 8_24_build/index
96 8_25_deploy/index
97
98
99Part 9 : Appendices
90-------------------100-------------------
91101
92.. toctree::102.. toctree::

Subscribers

People subscribed via source and target branches

to status/vote changes: