forked from herlesupreeth/FHoSS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
install.txt
129 lines (97 loc) · 6.73 KB
/
install.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
######################################################################################################################################
OpenIMSCore - FHoSS Project
FOKUS Fraunhofer Institute, Berlin, Germany
######################################################################################################################################
--------------------------------------------------------------------------------------------------------------------------------------
Simple Steps for compiling and installing FHoSS:
--------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------
1. Checkout the sources from SVN
--------------------------------------------------------------------------------------------------------------------------------------
"svn checkout"
--------------------------------------------------------------------------------------------------------------------------------------
2. Compile all the sources
--------------------------------------------------------------------------------------------------------------------------------------
"ant compile"
--------------------------------------------------------------------------------------------------------------------------------------
3. Deploy the HSS
--------------------------------------------------------------------------------------------------------------------------------------
3.1. Set the desired path for the deployment in "build.properties" (implicitly this is the "deploy" folder from the base directory).
3.2. Deploy the application to the specified path.
"ant deploy"
3.3 IMPORTANT NOTE: regarding reinstallation and updates
If you just updated FHoSS sources and you make only a reinstallation, please make a clean with "ant cleanall" or remove manually the
old "deploy/" folder before you'll make the new deployment! If you do not want to remove your old deployment, please chose another
directory for the new installation. Otherwise, conflicts between versions could occur!
--------------------------------------------------------------------------------------------------------------------------------------
4. Configuration after deploy
--------------------------------------------------------------------------------------------------------------------------------------
Default configuration is made for all the needed files to run FHoSS on the "localhost". However, you should take a look on these files
and modify some parameters as appropriate for your installation.
4.1. Configure the required configuration files located in the root of the deployment directory:
- "DiameterPeerHSS.xml": You should modify the peer configuration here: like the FQDN, Realm, Acceptor Port or Authorized
identifiers. (See the JavaDiameterPeer documentation for details on how to set up the Diameter peer.)
- "hibernate.properties": You should configure the main properties for hibernate; implicitly is configured to connect to the
"mysql" on the localhost (127.0.0.1:3306). The most relevant properties are:
* hibernate.connection.url=jdbc:mysql://127.0.0.1:3306/hssdb
* hibernate.connection.username=hss
* hibernate.connection.password=hss
- "hss.properties": Specify configuration like: "IP address" on which the tomcat is listening (e.g. host=localhost) or other
parameters like: "operatorId", "amfId" and configuration parameters relating to the Milenage algorithm (usage of "AK", "IND length",
"delta" or "L") can be specified here. Moreover, the IFC Notification mechanism for Sh interface can be enabled or disabled
through the same file.
- "log4j.properties": Contains configuration for the logger. The most relevant things here, are the output file path of the logger
and the level of logging. The implicit configuration is saving the logs in the "logs/" folder of the deployment.
4.2 If you want to change some Tomcat configuration files, you will find them in "conf/" folder of the deployment directory
(tomcat-users.xml contains the "hss" and "hssAdmin" users defined).
--------------------------------------------------------------------------------------------------------------------------------------
5. Setup the database
--------------------------------------------------------------------------------------------------------------------------------------
5.1 Install mysql on your machine (if you haven't already done so)
5.2 Run the script that creates the database and the tables.
"mysql -u admin -p <hss_db.sql"
5.3 Run the script that creates two demo users
"mysql -u admin -p <userdata.sql"
5.4 The users and passwords that are implicitly set for the FHoSS
5.4.1 for interacting with mysql
user: hss
password: hss
5.4.2 for the web interface
read-only user:
user: hss
password: hss
administrator:
user: hssAdmin
password: hss
You can change these values editing the "conf/tomcat-users.xml" file from your deployment folder.
--------------------------------------------------------------------------------------------------------------------------------------
6. Running the FHoSS
--------------------------------------------------------------------------------------------------------------------------------------
6.1 go in the deployment directory
"cd deploy"
6.2 execute the start script
on Linux machines, launch
"sh startup.sh"
on Windows machines, launch
"startup.cmd"
6.3 Access the web interface management console
if the HSS was deployed only on "localhost" you will find it here: http://localhost:8080
--------------------------------------------------------------------------------------------------------------------------------------
8. Adding new IMS users
--------------------------------------------------------------------------------------------------------------------------------------
At this point you have 2 demo users with one standard service profile already in the database. These are:
Alice:
-----------
public identity: sip:alice@open-ims.test
private identity: alice@open-ims.test
secret key: alice
Bob:
-----------
public identity: sip:bob@open-ims.test
private identity: bob@open-ims.test
secret key: bob
You can use the web interface to see the existing users and their settings, to add, to modify or to create
new users, service profiles, triggering points, and more settings.
--------------------------------------------------------------------------------------------------------------------------------------
9. Now you are ready to test a registration on the IMS using FHoSS!
--------------------------------------------------------------------------------------------------------------------------------------