Information

Created in: 2005-12-21 22:48:55

Author: martin

Size: 9145 bytes

Last updated: 2005-12-21 22:48:55

You may be interested in...

There isn't related documents

Installation guide

Here you will find information about how to install jLibrary client and server packages.

Client installation

The following steps explain how to install jLibrary client. jLibrary, doesn't need a dedicated standalone server to run.

The first thing you must do is to download the latest packages from jLibrary home page. You can found them at at http://sourceforge.net/project/showfiles.php?group_id=95837.
Once downloaded, you have to uncompress client package on a directory on your hard disk. jLibrary by default creates a directory called jlibrary-client.
After uncompressing the client package, you only will have to run the binary executable file for your platform. For example, in linux platform you should run ./jlibrary.sh, and on windows platforms you should run jlibrary.exe
For Windows platforms there is an installer that will make this tasks for you. You only will have to follow the wizard steps and jLibrary will be installed transparently.

Server installation

After downloading the jLibrary standalone server package, you will found that it's configured to use HypersonicSQL. This is not the recommended database, and we have found several problems with this. HypersonicSQL is too much simple for production systems. Within the jlibrary configuration file, you will found several configurations, for several databases. In that configurations there are usernames, passwords, and database names that surely won't adjust to your current parameters. So, it's very important that you read the following paragraph where I'll explain how you could use another database or configure database properties.

To install the jLibrary server, you must follow these steps:

Download the latest packages from: http://sourceforge.net/project/showfiles.php?group_id=95837.
Once downloaded, uncompress the jLibrary server package in a directory on your hard disk. By default, jLibrary comes bundled in a subdirectory called jlibrary-server.
jLibrary trae incluido Tomcat 5.0. Para lanzar el servidor de jLibrary simplemente hay que ir al directorio bin y ejecutar el fichero de arranque de su plataforma. Por ejemplo en plataformas Linux sería ./startup.sh y en plataformas Windows startup.bat.

Please be sure that the database is correctly configured before starting jLibrary server. You must also define the JAVA_HOME to a correct JRE/JDK installation.

jLibrary server must be launched from the bin directory. For example, to stat jlibrary in linux platforms you should do : cd bin, and ./jlibrary.sh. And on windows platforms you should do cd bin, and startup.bat
By default, jLibrary server is installed on port number 8080. You can easily check if jLibrary is running, launching from any standard browser the url http://localhost:8080/jLibrary, that should bring up the Apache Axis web services interface.
jLibrary can also be installed in any other port number. To do this, you only have to configure the internal Tomcat server. Refer to the tomcat documentation to find more information about how to do this.

Once the jLibrary standalone server has been started, it will be accesible from any jlibrary client using a jlibrary URL like this: jlibrary://localhost:8080.

jLibrary configuration

This information is only for administrators or advanced users.

Both, the jLibrary client and the jLibrary server can be configured using the file jlibrary.properties. The location of this file is different if you're working with the client internal jLibrary server:

jLibrary client: $INSTALL_DIR/workspace/org.jlibrary.client/conf/jlibrary.properties
jLibrary server: $INSTALL_DIR/conf/jlibrary.properties

In the next points are described some of the most interesting configuration options available. You can edit the configuration file to find more information.

Database configuration

You can choose your database from those that appears commented on the file. To use a database, uncomment the database commented lines, and comment the previously uncommented ones. jLibrary uses this information to load the JDBC drivers.
Here you can see an example configuration entries form MySQL:

jlibrary.sql.schema=org/jlibrary/core/persistence/data/MySQL-schema.sql
jlibrary.driver.username=martin
jlibrary.driver.password=
jlibrary.driver.name=org.gjt.mm.mysql.Driver
jlibrary.driver.url=jdbc:mysql://localhost/jlibrary
#jlibrary.autostart=true
Starting automatically your database with jLibrary

jLibrary client and server includes an embedded HypersonicSQL database. By default, this database is started at jLibrary server startup time, in both client and server. You can change this uncommenting the line jLibrary.autostart. If you wish to use another database, you must comment this line, because in other case jLibrary will try to start the configured database .
On the contrary, be sure to not comment this line, if you don't have any database on your machine.
Language configuration

jLibrary supports internationalization. In this version, both English and Spanish are supported. jLibrary always will use the default locale of the system. If the locale isn't supported, then it will look on the configuration file. Finally, if the locale in this file is also not supported, then it will use English as the default language. You can specify a locale on the configuration file using the property jlibrary.locale.
Storage configuration

By default, jLibrary stores uses as home directory ../jlibrary-home, and as repositories home directory ../jlibrary-home/repositories. You can change this using the properties jlibrary.home and jlibrary.repositories.home. On the server, changing this property is important, so you can configure properly the storage. On the client, it won't be needed, as jLibrary client will ask you the repository home directory the first time you launch the application. But you can also do it if you want.
Limit the number of versions created

Each time you edit a document, jLibrary store the changes done, and creates new document versions. This versions allow to recuperate previous states of the document.

But, if you store too much versions, then you can use too much hard disk storage. You can limit the number of versions that jLibrary server creates using the property jlibrary.version.limit.

-martin

jLibrary