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
1=== added directory 'source/developer/8_24_build'
2=== added file 'source/developer/8_24_build/index.rst'
3--- source/developer/8_24_build/index.rst 1970-01-01 00:00:00 +0000
4+++ source/developer/8_24_build/index.rst 2011-02-09 16:45:08 +0000
5@@ -0,0 +1,149 @@
6+
7+Build
8+=====
9+
10+This page describes how to build a custom version of OpenERP for Windows.
11+
12+Dependencies
13+------------
14+
15+The first step is to build the dependences. To do so, grab the Windows installer branch::
16+
17+ bzr branch lp:~openerp-groupes/openerp/win-installer-trunk
18+
19+and install the packages:
20+
21+ * 7z465.msi
22+ * python-2.5.2.msi
23+ * setuptools-0.6c9.win32-py2.5.exe
24+ * Beaker-1.4.1.tar.gz
25+ * Mako-0.2.4.tar.gz
26+ * pytz-2010l.win32.exe
27+
28+Server
29+++++++
30+
31+Install the packages:
32+
33+ * lxml-2.1.2.win32-py2.5.exe
34+ * PIL-1.1.6.win32-py2.5.exe
35+ * psycopg2-2.2.2.win32-py2.5-pg9.0.1-release.exe
36+ * PyChart-1.39.win32.exe
37+ * pydot-1.0.2.win32.exe
38+ * python-dateutil-1.5.tar.gz
39+ * pywin32-212.win32-py2.5.exe
40+ * PyYAML-3.09.win32-py2.5.exe
41+ * ReportLab-2.2.win32-py2.5.exe
42+
43+Web
44++++
45+
46+Install the packages:
47+
48+ * Babel-0.9.4-py2.5.egg
49+ * CherryPy-3.1.2.win32.exe
50+ * FormEncode-1.2.2.tar.gz
51+ * simplejson-2.0.9-py2.5-win32.egg
52+ * xlwt-0.7.2.win32.exe
53+
54+Source distribution
55+-------------------
56+
57+The second step is to build a source distribution on Linux.
58+
59+Server
60+++++++
61+
62+Let's assume you work on your own server branch named **6.0** and you want to build a server with the following modules:
63+
64+ * base_setup
65+ * base_tools
66+ * board
67+
68+This implies that these modules have been linked in *bin/addons* by a command similar to::
69+
70+ ln -s ~/openerp/addons/6.0/{base_setup,base_tools,board} .
71+
72+To build the server, go to the root directory and type::
73+
74+ python setup.py sdist --format=zip
75+
76+You now have a new file in the **dist** directory, called openerp-server-M.m.P.zip where:
77+ * **M** is the major version, example 6
78+ * **m** is the minor version, example 0
79+ * **p** is the patch version, example 1
80+
81+Web
82++++
83+
84+To build the web client, go to the root directory and type::
85+
86+ python setup.py sdist --format=zip
87+
88+You now have a new file in the **dist** directory, called openerp-web-M.m.P.zip where:
89+ * **M** is the major version, example 6
90+ * **m** is the minor version, example 0
91+ * **p** is the patch version, example 1
92+
93+Binary distribution
94+-------------------
95+
96+The third step is to build a binary distribution on Windows.
97+
98+Server
99+++++++
100+
101+Open a command prompt and unzip the file::
102+
103+ 7z x openerp-server-M.m.P.zip -oC:\openerp
104+
105+Go to the **win32** directory::
106+
107+ cd C:\openerp\openerp-server-M.m.P\win32
108+
109+Generate the service exe with::
110+
111+ python setup.py py2exe
112+
113+Go to the parent directory::
114+
115+ cd ..
116+
117+Generate the server exe with::
118+
119+ python setup.py py2exe
120+
121+Build the Windows installer with::
122+
123+ makensis setup.nsi
124+
125+You 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.
126+
127+Web
128++++
129+
130+Open a command prompt and unzip the file::
131+
132+ 7z x openerp-web-M.m.P.zip -oC:\openerp
133+
134+Go to the **win32** directory::
135+
136+ cd C:\openerp\openerp-web-M.m.P\win32
137+
138+Generate the service exe with::
139+
140+ python setup.py py2exe
141+
142+Go to the parent directory::
143+
144+ cd ..
145+
146+Generate the web exe with::
147+
148+ python setup.py py2exe
149+
150+Build the Windows installer with::
151+
152+ makensis setup.nsi
153+
154+You 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.
155
156=== added directory 'source/developer/8_25_deploy'
157=== added file 'source/developer/8_25_deploy/index.rst'
158--- source/developer/8_25_deploy/index.rst 1970-01-01 00:00:00 +0000
159+++ source/developer/8_25_deploy/index.rst 2011-02-09 16:45:08 +0000
160@@ -0,0 +1,43 @@
161+
162+Deploy
163+======
164+
165+This page describes how to deploy a custom version of OpenERP on Windows.
166+
167+Package script
168+--------------
169+
170+The first step is to grab the package script branch::
171+
172+ bzr branch lp:~openerp-groupes/openerp/package-script
173+
174+Batch
175+-----
176+
177+Go to the *packaging* directory of the branch and copy the file *build.bat* to the *C:\\openerp* directory of your Windows machine.
178+
179+SSH server
180+----------
181+
182+You need to install a SSH server on Windows. You can for example install `freeSSHd <http://www.freesshd.com/>`_.
183+
184+Fabric
185+------
186+
187+You 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.
188+
189+Configure
190++++++++++
191+
192+Go to the *packaging* directory of the branch and edit the file fabfile.py. Change what need to be changed.
193+
194+Run
195++++
196+
197+run the command::
198+
199+ fab -H host -u user server
200+
201+where:
202+ * *host* is the Windows host name
203+ * *user* is the Windows user name
204
205=== modified file 'source/developer/index.rst'
206--- source/developer/index.rst 2010-12-31 00:03:27 +0000
207+++ source/developer/index.rst 2011-02-09 16:45:08 +0000
208@@ -86,7 +86,17 @@
209 Miscellaneous/index
210
211
212-Part 8 : Appendices
213+Part 8 : Build and deploy
214+-------------------------
215+
216+.. toctree::
217+ :maxdepth: 2
218+
219+ 8_24_build/index
220+ 8_25_deploy/index
221+
222+
223+Part 9 : Appendices
224 -------------------
225
226 .. toctree::

Subscribers

People subscribed via source and target branches

to status/vote changes: