1
=== modified file 'README.txt'
2
--- README.txt	2010-08-27 14:43:32 +0000
3
+++ README.txt	2010-11-19 16:20:40 +0000
4
@@ -1,30 +1,36 @@
5
1
1. Introduction
1
1. Introduction
6
2
2
22
3
This solution provides all the infrastruture changes that are required to run Ubuntu One on Windows. In order to
3
This solution provides all the infrastructure changes that are required to run
23
4
do this the solution provides the following:
4
Ubuntu One on Windows. To do this we provide the following:
24
5
5
25
6
	* Unbutu One sync daemon: The daemon that will be performing the file sync.
6
	* UbuntuOne sync daemon: The daemon that will be performing the file sync.
26
7
	* UbuntuOne Windows Service: Windows service that allows to start, stop, pause and resume the sync daemon.
7
    * UbuntuOne Windows Service: Windows service that allows to start, stop,
27
8
	* UbuntuOne Windows Service Brodcaster: Provides a WCF service hosted in a windows service that allows to .Net languages
8
      pause and resume the sync daemon.
28
9
	  to communicate with the sync daemon and interact with it.
9
    * UbuntuOne Windows Service Brodcaster: Provides a WCF service hosted in a
29
10
10
      windows service that allows .Net languages to communicate with the sync
30
11
2. Enviroment setup
11
      daemon and interact with it.
31
12
12
32
13
The ubuntuone windows port solution provides a port of the python code that is used on Linux to perform the u1 sync operations. Due to the fact that 
13
2. Environment setup
33
14
we did not want user to have to be hunting down the python runtime plus the differen modules that have been used. To simplify the live of the 
14
34
15
windows users we have opted to use py2exe to create an executable that will carry all the different python dependencies of the code. As you
15
The UbuntuOne windows port provides a port of the python code that is used on
35
16
may already know py2exe is not perfect and does not support egg files. In order to make sure that you easy_install does extra the eggs files after
16
Linux to perform the U1 sync operations. We did not want to request that the
36
17
the packages are installed please use the following command:
17
user hunt down both the python runtime and necessary dependencies. To simplify
37
18
the life of the windows users we have opted to use py2exe to create an
38
19
executable that will carry all the different python dependencies of the code.
39
20
As you may already know, py2exe is not perfect and does not support egg files.
40
21
So when using easy_install to install packages, use the following command:
41
18
22
42
19
easy_install -Z %package_name%
23
easy_install -Z %package_name%
43
20
24
45
21
In order to be able to build the solution you will need to have python win32, the win32 python extensions and the ubuntu one storage protocol in your system.:
25
To build the solution you will need to have python win32, the win32 python
46
26
extensions and the UbuntuOne storage protocol on your system.:
47
22
27
48
23
28
49
24
3. Build
29
3. Build
50
25
30
53
26
In order to simplify the buil as much as possible, all the required tools for the compilation of the project are provided in the soruce tree. The 
31
To simplify the build, all tools required to compile the project are provided
54
27
compilation uses a nant project that allows to run the following targets:
32
in the source tree. Compilation uses a nant project supporting the following
55
33
targets:
56
28
34
57
29
	2.1 clean
35
	2.1 clean
58
30
36
59
@@ -32,40 +38,46 @@
60
32
38
61
33
	2.2 generate_protos
39
	2.2 generate_protos
62
34
40
65
35
	The project uses protobuffer for IPC. This target will compile the .cs files that generate the protbuffers code that is later 
41
    The project uses protobuffer for IPC. This target will compile the .cs
66
36
	compiled.
42
    files that generate the protbuffers code that is later compiled.
67
37
43
68
38
	2.3 build
44
	2.3 build
69
39
45
72
40
	Compiles the solution ensuring that the protobuffer are generated using the protobuffer compiler. Once the protobuffer are generated the
46
    Compiles the solution ensuring that the protobuffer are generated using the
73
41
	target will compile the solution using MSBuild
47
    protobuffer compiler. Once the protobuffer are generated the target will
74
48
    compile the solution using MSBuild
75
42
49
76
43
	2.4 tests
50
	2.4 tests
77
44
51
80
45
	Compiles the solution using the "build" target and runs the unit tests. The output of the unit tests will be placed in a newly created dir at the 
52
    Compiles the solution using the "build" target and runs the unit tests. The
81
46
	root called "test-results".
53
    output of the unit tests will be placed in a newly created dir at the root
82
54
    called "test-results".
83
47
	
55
	
84
48
	2.5 installer
56
	2.5 installer
85
49
	
57
	
87
50
	Creates an msi installer that can be used to install Ubuntu One in a windows machine.
58
    Creates an msi installer that can be used to install UbuntuOne on a
88
59
    windows machine.
89
51
	
60
	
90
52
	2.6 bootstrapper
61
	2.6 bootstrapper
91
53
	
62
	
93
54
	Crates a boot strapper that will allow to install a bundle with UbuntuOne that includes Tomboy and Gtk sharp if needed.
63
    Crates a boot strapper that will allow to install a bundle with UbuntuOne
94
64
    that includes Tomboy and Gtk sharp if needed.
95
55
	
65
	
96
56
	2.7 create_update
66
	2.7 create_update
97
57
	
67
	
99
58
	Creates the msi that will be used to update the application, updates the rss used to notify updates an uploads the data to the server.
68
    Creates the msi that will be used to update the application, update the
100
69
    RSS feed with the new version, and upload the package to the server.
101
59
	
70
	
104
60
	Bare in mind that to be able to execute create_update you have to have the rights to update the data in canonicals S3. In order to do that 
71
    Bear in mind that to execute create_update you have to have the access
105
61
	you have to set the following enviroment valirables in your windows machine:
72
    rights to update the data in Canonical's S3. You will need to
106
73
    set the following environment variables on your windows machine:
107
62
	
74
	
108
63
	AWS_ACCESS_KEY_ID: The account Id
75
	AWS_ACCESS_KEY_ID: The account Id
109
64
	AWS_SECRET_ACCESS_KEY: The secret required to use the account.
76
	AWS_SECRET_ACCESS_KEY: The secret required to use the account.
110
65
	
77
	
112
66
	In order to run the script you will need to have boto () to be able to use S3.
78
    The script requires the python package boto to interact with S3.
113
67
79
115
68
In order to execute the build script execute at the root of the project
80
To execute the build script, cd to the root of the project and execute:
116
69
81
117
70
tools\Nant\bin\nant.exe <target>
82
tools\Nant\bin\nant.exe <target>
118
71
83
Status:	Merged
Approved by:	Vincenzo Di Somma on 2010-11-22
Approved revision:	117
Merged at revision:	142
Proposed branch:	lp:~jameinel/ubuntuone-windows-installer/readme_fixes
Merge into:	lp:ubuntuone-windows-installer/beta
Diff against target:	117 lines (+43/-31) 1 file modified README.txt (+43/-31)
To merge this branch:	bzr merge lp:~jameinel/ubuntuone-windows-installer/readme_fixes
Related bugs:	Link a bug report
Reviewer	Date Requested	Status
Vincenzo Di Somma (community)		Approve on 2010-11-22
Manuel de la Peña (community)	2010-11-19	Approve on 2010-11-22
Review via email: mp+41335@code.launchpad.net
1	=== modified file 'README.txt'
2	--- README.txt 2010-08-27 14:43:32 +0000
3	+++ README.txt 2010-11-19 16:20:40 +0000
4	@@ -1,30 +1,36 @@
5	1	1. Introduction	1	1. Introduction
6	2		2
22	3	This solution provides all the infrastruture changes that are required to run Ubuntu One on Windows. In order to	3	This solution provides all the infrastructure changes that are required to run
23	4	do this the solution provides the following:	4	Ubuntu One on Windows. To do this we provide the following:
24	5		5
25	6	* Unbutu One sync daemon: The daemon that will be performing the file sync.	6	* UbuntuOne sync daemon: The daemon that will be performing the file sync.
26	7	* UbuntuOne Windows Service: Windows service that allows to start, stop, pause and resume the sync daemon.	7	* UbuntuOne Windows Service: Windows service that allows to start, stop,
27	8	* UbuntuOne Windows Service Brodcaster: Provides a WCF service hosted in a windows service that allows to .Net languages	8	pause and resume the sync daemon.
28	9	to communicate with the sync daemon and interact with it.	9	* UbuntuOne Windows Service Brodcaster: Provides a WCF service hosted in a
29	10		10	windows service that allows .Net languages to communicate with the sync
30	11	2. Enviroment setup	11	daemon and interact with it.
31	12		12
32	13	The ubuntuone windows port solution provides a port of the python code that is used on Linux to perform the u1 sync operations. Due to the fact that	13	2. Environment setup
33	14	we did not want user to have to be hunting down the python runtime plus the differen modules that have been used. To simplify the live of the	14
34	15	windows users we have opted to use py2exe to create an executable that will carry all the different python dependencies of the code. As you	15	The UbuntuOne windows port provides a port of the python code that is used on
35	16	may already know py2exe is not perfect and does not support egg files. In order to make sure that you easy_install does extra the eggs files after	16	Linux to perform the U1 sync operations. We did not want to request that the
36	17	the packages are installed please use the following command:	17	user hunt down both the python runtime and necessary dependencies. To simplify
37			18	the life of the windows users we have opted to use py2exe to create an
38			19	executable that will carry all the different python dependencies of the code.
39			20	As you may already know, py2exe is not perfect and does not support egg files.
40			21	So when using easy_install to install packages, use the following command:
41	18		22
42	19	easy_install -Z %package_name%	23	easy_install -Z %package_name%
43	20		24
45	21	In order to be able to build the solution you will need to have python win32, the win32 python extensions and the ubuntu one storage protocol in your system.:	25	To build the solution you will need to have python win32, the win32 python
46			26	extensions and the UbuntuOne storage protocol on your system.:
47	22		27
48	23		28
49	24	3. Build	29	3. Build
50	25		30
53	26	In order to simplify the buil as much as possible, all the required tools for the compilation of the project are provided in the soruce tree. The	31	To simplify the build, all tools required to compile the project are provided
54	27	compilation uses a nant project that allows to run the following targets:	32	in the source tree. Compilation uses a nant project supporting the following
55			33	targets:
56	28		34
57	29	2.1 clean	35	2.1 clean
58	30		36
59	@@ -32,40 +38,46 @@
60	32		38
61	33	2.2 generate_protos	39	2.2 generate_protos
62	34		40
65	35	The project uses protobuffer for IPC. This target will compile the .cs files that generate the protbuffers code that is later	41	The project uses protobuffer for IPC. This target will compile the .cs
66	36	compiled.	42	files that generate the protbuffers code that is later compiled.
67	37		43
68	38	2.3 build	44	2.3 build
69	39		45
72	40	Compiles the solution ensuring that the protobuffer are generated using the protobuffer compiler. Once the protobuffer are generated the	46	Compiles the solution ensuring that the protobuffer are generated using the
73	41	target will compile the solution using MSBuild	47	protobuffer compiler. Once the protobuffer are generated the target will
74			48	compile the solution using MSBuild
75	42		49
76	43	2.4 tests	50	2.4 tests
77	44		51
80	45	Compiles the solution using the "build" target and runs the unit tests. The output of the unit tests will be placed in a newly created dir at the	52	Compiles the solution using the "build" target and runs the unit tests. The
81	46	root called "test-results".	53	output of the unit tests will be placed in a newly created dir at the root
82			54	called "test-results".
83	47		55
84	48	2.5 installer	56	2.5 installer
85	49		57
87	50	Creates an msi installer that can be used to install Ubuntu One in a windows machine.	58	Creates an msi installer that can be used to install UbuntuOne on a
88			59	windows machine.
89	51		60
90	52	2.6 bootstrapper	61	2.6 bootstrapper
91	53		62
93	54	Crates a boot strapper that will allow to install a bundle with UbuntuOne that includes Tomboy and Gtk sharp if needed.	63	Crates a boot strapper that will allow to install a bundle with UbuntuOne
94			64	that includes Tomboy and Gtk sharp if needed.
95	55		65
96	56	2.7 create_update	66	2.7 create_update
97	57		67
99	58	Creates the msi that will be used to update the application, updates the rss used to notify updates an uploads the data to the server.	68	Creates the msi that will be used to update the application, update the
100			69	RSS feed with the new version, and upload the package to the server.
101	59		70
104	60	Bare in mind that to be able to execute create_update you have to have the rights to update the data in canonicals S3. In order to do that	71	Bear in mind that to execute create_update you have to have the access
105	61	you have to set the following enviroment valirables in your windows machine:	72	rights to update the data in Canonical's S3. You will need to
106			73	set the following environment variables on your windows machine:
107	62		74
108	63	AWS_ACCESS_KEY_ID: The account Id	75	AWS_ACCESS_KEY_ID: The account Id
109	64	AWS_SECRET_ACCESS_KEY: The secret required to use the account.	76	AWS_SECRET_ACCESS_KEY: The secret required to use the account.
110	65		77
112	66	In order to run the script you will need to have boto () to be able to use S3.	78	The script requires the python package boto to interact with S3.
113	67		79
115	68	In order to execute the build script execute at the root of the project	80	To execute the build script, cd to the root of the project and execute:
116	69		81
117	70	tools\Nant\bin\nant.exe <target>	82	tools\Nant\bin\nant.exe <target>
118	71		83