doc/install-guide.lyx

   1 #LyX 1.4.4 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 245
   3 \begin_document
   4 \begin_header
   5 \textclass paper
   6 \begin_preamble
   7 \usepackage{hyperref}
   8 \end_preamble
   9 \language english
  10 \inputencoding auto
  11 \fontscheme default
  12 \graphics default
  13 \paperfontsize default
  14 \spacing single
  15 \papersize default
  16 \use_geometry false
  17 \use_amsmath 1
  18 \cite_engine basic
  19 \use_bibtopic false
  20 \paperorientation portrait
  21 \secnumdepth 3
  22 \tocdepth 3
  23 \paragraph_separation indent
  24 \defskip medskip
  25 \quotes_language english
  26 \papercolumns 1
  27 \papersides 1
  28 \paperpagestyle default
  29 \tracking_changes false
  30 \output_changes false
  31 \end_header
  32
  33 \begin_body
  34
  35 \begin_layout Title
  36 Funambol DS Server installation guide for the GroupDAV Connector
  37 \end_layout
  38
  39 \begin_layout Section
  40 Prerequisites
  41 \end_layout
  42
  43 \begin_layout Standard
  44 This article discusses installing the Funambol Device Sync server and the
  45  GroupDAV connector module, over a Tomcat 5 application server install.
  46  A level of knowledge with a Unix-like OS is assumed.
  47
  48 \end_layout
  49
  50 \begin_layout Subsubsection
  51 Useful outside documentation
  52 \end_layout
  53
  54 \begin_layout Itemize
  55 Funambol provides a set of documentation for all aspects of the DS server,
  56  which may be downloaded at
  57 \begin_inset LatexCommand \url{http://www.funambol.com/opensource/documentation/documents.html}
  58
  59 \end_inset
  60
  61
  62 \end_layout
  63
  64 \begin_layout Itemize
  65 Several install guides are available at the
  66 \begin_inset LatexCommand \url{http://docs.opengroupware.org/search?SearchableText=Funambol}
  67
  68 \end_inset
  69
  70
  71 \end_layout
  72
  73 \begin_layout Subsubsection
  74 Required files
  75 \end_layout
  76
  77 \begin_layout Itemize
  78 Tomcat 5.0 (
  79 \emph on
  80 not
  81 \emph default
  82  5.5)
  83 \begin_inset LatexCommand \url{http://tomcat.apache.org/download-55.cgi#5.0.30-beta}
  84
  85 \end_inset
  86
  87
  88 \end_layout
  89
  90 \begin_layout Itemize
  91 HSQLDB database - in particular hsqldb.jar
  92 \begin_inset LatexCommand \url{http://sourceforge.net/project/showfiles.php?group_id=23316&package_id=16653&release_id=339171}
  93
  94 \end_inset
  95
  96
  97 \end_layout
  98
  99 \begin_layout Itemize
 100 Funambol DS Server 5.0.10 archive
 101 \begin_inset LatexCommand \url{http://www.funambol.com/opensource/download_form.html?file_id=funambol-ds-server-5.0.10.zip}
 102
 103 \end_inset
 104
 105
 106 \end_layout
 107
 108 \begin_layout Itemize
 109 From the download directory for the connector version
 110 \begin_inset LatexCommand \url{http://comalies.citadel.org/~matt/funambol/latest/}
 111
 112 \end_inset
 113
 114
 115 \begin_inset LatexCommand \url{http://latest.bionicmessage.net}
 116
 117 \end_inset
 118
 119
 120 \end_layout
 121
 122 \begin_deeper
 123 \begin_layout Itemize
 124 GroupDAV Funambol s4j (groupdav-1.x.xxxx.s4j)
 125 \end_layout
 126
 127 \begin_layout Itemize
 128 JGroupDAV.jar
 129 \end_layout
 130
 131 \begin_layout Itemize
 132 gdav_libs.tar.bz2
 133 \end_layout
 134
 135 \end_deeper
 136 \begin_layout Itemize
 137 Funambol Administration Tool 3.0.9
 138 \begin_inset LatexCommand \url{http://www.funambol.com/opensource/download_form.html?file_id=funambol-admin-3.0.9.tgz}
 139
 140 \end_inset
 141
 142
 143 \end_layout
 144
 145 \begin_layout Itemize
 146 And
 147 \emph on
 148 most importantly
 149 \emph default
 150  of all, you will need a Java 5 Development Kit, obtainable from
 151 \begin_inset LatexCommand \url{http://java.sun.com}
 152
 153 \end_inset
 154
 155  for most platforms.
 156  IBM's developer kits also work.
 157 \end_layout
 158
 159 \begin_layout Section
 160 Tomcat 5.0
 161 \end_layout
 162
 163 \begin_layout Standard
 164 Tomcat 5 does not need any installation, merely untarring.
 165 \end_layout
 166
 167 \begin_layout Itemize
 168 \begin_inset ERT
 169 status open
 170
 171 \begin_layout Standard
 172
 173
 174 \backslash
 175 texttt{tar -zxvf jakarta-tomcat-5.0.30.tar.gz}
 176 \end_layout
 177
 178 \end_inset
 179
 180
 181 \end_layout
 182
 183 \begin_layout Itemize
 184 Take note of the location you install Tomcat to.
 185 \end_layout
 186
 187 \begin_layout Section
 188 HSQLDB
 189 \end_layout
 190
 191 \begin_layout Standard
 192 HSQLDB is the database this tutorial will be using for Funambol, however,
 193  if you wish to use another database, follow the instructions in Funambol's
 194  literature
 195 \end_layout
 196
 197 \begin_layout Itemize
 198 Create a directory on your system.
 199  HSQLDB is in <hsqldb.zip</lib/hsqldb.jar.
 200  Copy the jar into this directory.
 201
 202 \end_layout
 203
 204 \begin_layout Itemize
 205 Then, fire up your favorite text editor and create a script:
 206 \end_layout
 207
 208 \begin_layout Itemize
 209 \begin_inset ERT
 210 status open
 211
 212 \begin_layout Standard
 213
 214
 215 \backslash
 216 texttt{/bin/sh}
 217 \end_layout
 218
 219 \begin_layout Standard
 220
 221
 222 \backslash
 223 texttt{java -classpath hsqldb.jar org.hsqldb.Server -database.0 fnbl -dbname.0
 224  fnbl}
 225 \end_layout
 226
 227 \end_inset
 228
 229
 230 \end_layout
 231
 232 \begin_layout Itemize
 233 Save it and make the file executable.
 234  Next, run the script to start HSQLDB.
 235  (you may want to execute it in screen or create an init script)
 236 \end_layout
 237
 238 \begin_layout Section
 239 Funambol DS Server
 240 \end_layout
 241
 242 \begin_layout Standard
 243 Unzip the Funambol archive and move its contents to a permanent place on
 244  your system.
 245  The files will be extracted to
 246 \begin_inset ERT
 247 status open
 248
 249 \begin_layout Standard
 250
 251
 252 \backslash
 253 texttt{Funambol/ds-server}
 254 \end_layout
 255
 256 \end_inset
 257
 258 .
 259  The instructions below are relative to
 260 \begin_inset ERT
 261 status open
 262
 263 \begin_layout Standard
 264
 265
 266 \backslash
 267 texttt{ds-server}
 268 \end_layout
 269
 270 \end_inset
 271
 272 Then open up a terminal and export the following variables:
 273 \end_layout
 274
 275 \begin_layout Itemize
 276 export JAVA_HOME=<location_of_your_java_jdk>
 277 \end_layout
 278
 279 \begin_layout Itemize
 280 export J2EE_HOME=<location_of_tomcat>
 281 \end_layout
 282
 283 \begin_layout Itemize
 284 (Suggestion: save the exports as a shell script so you can source them when
 285  needed.
 286 \end_layout
 287
 288 \begin_layout Itemize
 289 Copy the
 290 \begin_inset ERT
 291 status open
 292
 293 \begin_layout Standard
 294
 295
 296 \backslash
 297 texttt{groupdav-1.x.xxxx.s4j}
 298 \end_layout
 299
 300 \end_inset
 301
 302  archive to
 303 \begin_inset ERT
 304 status open
 305
 306 \begin_layout Standard
 307
 308
 309 \backslash
 310 texttt{
 311 \backslash
 312 <funambol
 313 \backslash
 314 >/modules}
 315 \end_layout
 316
 317 \end_inset
 318
 319 .
 320 \end_layout
 321
 322 \begin_layout Itemize
 323 Un tar
 324 \begin_inset ERT
 325 status open
 326
 327 \begin_layout Standard
 328
 329
 330 \backslash
 331 texttt{gdav_libs.tar.bz2}
 332 \end_layout
 333
 334 \end_inset
 335
 336  and copy the jar files in it to
 337 \begin_inset ERT
 338 status open
 339
 340 \begin_layout Standard
 341
 342
 343 \backslash
 344 texttt{
 345 \backslash
 346 <funambol
 347 \backslash
 348 >/default/lib}
 349 \end_layout
 350
 351 \end_inset
 352
 353
 354 \end_layout
 355
 356 \begin_layout Itemize
 357 Open
 358 \begin_inset ERT
 359 status open
 360
 361 \begin_layout Standard
 362
 363
 364 \backslash
 365 texttt{install.properties}
 366 \end_layout
 367
 368 \end_inset
 369
 370  and start by changing the
 371 \begin_inset ERT
 372 status open
 373
 374 \begin_layout Standard
 375
 376
 377 \backslash
 378 texttt{dbms=postgresql}
 379 \end_layout
 380
 381 \end_inset
 382
 383  line into
 384 \begin_inset ERT
 385 status open
 386
 387 \begin_layout Standard
 388
 389
 390 \backslash
 391 texttt{dmbs=hypersonic}
 392 \end_layout
 393
 394 \end_inset
 395
 396
 397 \end_layout
 398
 399 \begin_layout Itemize
 400 Scroll down to the bottom and replace the postgresql defaults with:
 401 \end_layout
 402
 403 \begin_deeper
 404 \begin_layout Itemize
 405 \begin_inset ERT
 406 status open
 407
 408 \begin_layout Standard
 409
 410
 411 \backslash
 412 texttt{jdbc.classpath=
 413 \backslash
 414 <PATH TO HSQLDB.JAR
 415 \backslash
 416 >}
 417 \end_layout
 418
 419 \begin_layout Standard
 420
 421
 422 \backslash
 423 texttt{jdbc.driver=org.hsqldb.jdbcDriver}
 424 \end_layout
 425
 426 \begin_layout Standard
 427
 428
 429 \backslash
 430 texttt{jdbc.url=jdbc:hsqldb:hsql://localhost/fnbl
 431 \end_layout
 432
 433 \begin_layout Standard
 434
 435
 436 \backslash
 437 texttt{jdbc.user=sa}
 438 \end_layout
 439
 440 \begin_layout Standard
 441
 442
 443 \backslash
 444 texttt{jdbc.password=}
 445 \end_layout
 446
 447 \end_inset
 448
 449
 450 \end_layout
 451
 452 \end_deeper
 453 \begin_layout Itemize
 454 Just below the SQL configuration there is a
 455 \begin_inset ERT
 456 status open
 457
 458 \begin_layout Standard
 459
 460
 461 \backslash
 462 texttt{modules-to-install}
 463 \end_layout
 464
 465 \end_inset
 466
 467  line
 468 \begin_inset Quotes erd
 469 \end_inset
 470
 471
 472 \end_layout
 473
 474 \begin_deeper
 475 \begin_layout Itemize
 476 \begin_inset ERT
 477 status open
 478
 479 \begin_layout Standard
 480
 481
 482 \backslash
 483 texttt{modules-to-install=foundation-3.0.9,pdi-3.0.5,pimweb-3.0.8,funambol-db-3.0.7}
 484 \end_layout
 485
 486 \end_inset
 487
 488
 489 \end_layout
 490
 491 \begin_layout Itemize
 492 \begin_inset ERT
 493 status open
 494
 495 \begin_layout Standard
 496
 497
 498 \backslash
 499 texttt{modules-to-install=foundation-3.0.9,pdi-3.0.5,pimweb-3.0.8,funambol-db-3.0.7,grou
 500 pdav-1.1.xxxx
 501 \end_layout
 502
 503 \end_inset
 504
 505
 506 \end_layout
 507
 508 \end_deeper
 509 \begin_layout Itemize
 510 Next, make the install scripts
 511 \begin_inset ERT
 512 status open
 513
 514 \begin_layout Standard
 515
 516
 517 \backslash
 518 texttt{bin/install.sh, bin/install-modules.sh}
 519 \end_layout
 520
 521 \end_inset
 522
 523 executable, and install Funambol:
 524 \end_layout
 525
 526 \begin_deeper
 527 \begin_layout Itemize
 528 \begin_inset ERT
 529 status open
 530
 531 \begin_layout Standard
 532
 533
 534 \backslash
 535 texttt{chmod +x bin/install.sh}
 536 \end_layout
 537
 538 \begin_layout Standard
 539
 540
 541 \backslash
 542 texttt{chmod +x bin/install-modules.sh}
 543 \end_layout
 544
 545 \begin_layout Standard
 546
 547
 548 \backslash
 549 texttt{bin/install.sh tomcat50}
 550 \end_layout
 551
 552 \end_inset
 553
 554
 555 \end_layout
 556
 557 \end_deeper
 558 \begin_layout Itemize
 559 The script will ask you if you wish to replace the database for each module.
 560  Answer
 561 \emph on
 562 Y
 563 \emph default
 564 (yes) to each one.
 565 \end_layout
 566
 567 \begin_layout Standard
 568
 569 \noun on
 570 Attention!
 571 \noun default
 572 If you already have services running on port 8080, edit the tomcat config
 573  file in
 574 \begin_inset ERT
 575 status open
 576
 577 \begin_layout Standard
 578
 579
 580 \backslash
 581 texttt{<tomcat>/conf/server.xml}
 582 \end_layout
 583
 584 \end_inset
 585
 586
 587 \end_layout
 588
 589 \begin_layout Standard
 590 Funambol can now be started by:
 591 \end_layout
 592
 593 \begin_layout Standard
 594 \begin_inset ERT
 595 status open
 596
 597 \begin_layout Standard
 598
 599
 600 \backslash
 601 texttt{bin/start.sh}
 602 \end_layout
 603
 604 \end_inset
 605
 606
 607 \end_layout
 608
 609 \end_body
 610 \end_document