forked from exoplatform/platform
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
208 lines (151 loc) · 7.05 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
Welcome to Platform
==================
This document explains how to build and package Platform bundles with Tomcat or JBoss
Prerequisites
=============
- Java Development Kit 1.6
- Recent Git client
- Recent Maven 3
- The eXo server will run on port 8080, make sure this port is not currently in use
Build configuration
===================
1) Profile configuration
Platform build uses several profiles to configure which packaging to be generated
When no profile is specified it will build only entreprise Tomcat bundle.
The various profiles used inside platform are :
- pkg-jboss : generate the jboss eap entreprise bundle
- pkg-community : generate the tomcat community bundle
- pkg-trial : generate the tomcat trial bundle
- distrib : generate documentations + EAR distribution
2) Database configuration
By default the build uses a HSQLDB database. However, it is possible to use MySQL5, thanks to mysql profile.
Build instructions
==================
1) Clone Platform
--------------------------
git clone [email protected]:exodev/platform.git
cd platform
2) Prepare containers to use for packaging
------------------------------------------
Create a directory on your disk that will contain specific versions of JBoss AS, Tomcat, used as a packaging server.
Let’s refer to this directory as SERVERS_DIR.
2) Build and package platform
----------------------------------
You can build platform without packaging (only entreprise Tomcat bundle)it by using the following command:
mvn clean install -Dmaven.test.skip=true
But that's only usable for development since in order to be able to run platform you have to package it.
Platform can be packaged with different web / application servers. The specific server to use is selected by using an appropriate profile.
Packaging with JBoss-AS
--------------------------------
If you don’t have an existing JBoss AS distribution, the build can automatically download it for you.
Issue the following command:
mvn install -Ppkg-jboss -Dmaven.test.skip=true -Ddownload
If you have an existing JBoss-EAP distribution unpack it into SERVERS_DIR directory so that you get SERVERS_DIR/jboss-EAP-XYZ directory.
In this case you can issue the following command:
mvn install -Ppkg-jboss -Dmaven.test.skip=true -Dservers.dir=$SERVERS_DIR
The packaged Platform is available in packaging/jboss-bundle/target/
To start it, go to jboss directory, and run 'bin/run.sh' ('bin\run.bat' on Windows).
Access the portal at: https://localhost:8080/portal
Packaging Community bundle with Tomcat 6.0.32
---------------------------
If you don’t have an existing Tomcat 6.0.32 distribution, the build can automatically download it for you.
Issue the following command:
mvn install -Ppkg-community -Pdownload
If you have an existing Tomcat 6.0.32 distribution, unpack it into SERVERS_DIR directory so that you get SERVERS_DIR/apache-tomcat-6.0.32 directory.
In this case you can issue the following command:
mvn install -Ppkg-community-DskipTests -Dservers.dir=$SERVERS_DIR -Dgatein.dev=tomcat6 -Dserver.name=apache-tomcat-6.0.32
The packaged Platform is available in packaging/tomcat/target/tomcat.
To start, go to tomcat6 directory, and run 'start_eXo.sh' ('start_eXo.bat run' on Windows).
Access the portal at: https://localhost:8080/portal
Troubleshooting
===============
Maven dependencies issues
-------------------------
While Platform should build without any extra maven repository configuration it may happen that the build complains about missing artifacts.
If you encounter this situation, please let us know via our forums (https://forum.exoplatform.org).
As a quick workaround you may try setting up maven repositories as follows.
Create file settings.xml in $HOME/.m2 (%HOMEPATH%\.m2 on Windows) with the following content:
<settings>
<profiles>
<profile>
<id>jboss-public-repository</id>
<repositories>
<repository>
<id>jboss-public-repository-group</id>
<name>JBoss Public Maven Repository Group</name>
<url>https://repository.jboss.org/nexus/content/groups/public-jboss/</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>jboss-public-repository-group</id>
<name>JBoss Public Maven Repository Group</name>
<url>https://repository.jboss.org/nexus/content/groups/public-jboss/</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
<profile>
<id>exo-public-repository</id>
<repositories>
<repository>
<id>exo-public-repository-group</id>
<name>eXo Public Maven Repository Group</name>
<url>https://repository.exoplatform.org/content/groups/public</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>exo-public-repository-group</id>
<name>eXo Public Maven Repository Group</name>
<url>https://repository.exoplatform.org/content/groups/public</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<activeProfiles>
<activeProfile>jboss-public-repository</activeProfile>
<activeProfile>exo-public-repository</activeProfile>
</activeProfiles>
</settings>
Going Further
=============
Your next stop will depend on who you are:
* Developers: learn how to build your own portal, gadgets, REST services or eXo-based applications in the Developer Guide [https://docs.exoplatform.com/PLF35/topic/org.exoplatform.doc.35/DeveloperGuide.html] and the Reference Documentation [https://docs.exoplatform.com/PLF35/topic/org.exoplatform.doc.35/GateInReferenceGuide.html]
* Administrators: learn how to install eXo Platform on a server in the Administrator Guide: https://docs.exoplatform.com/PLF35/topic/org.exoplatform.doc.35/AdministratorGuide.html
* End Users: learn more about using the features in the User Manuals: https://docs.exoplatform.com/PLF35/topic/org.exoplatform.doc.35/UserGuide.html