Starter's guide
Lucane is made of several modules :- a client
- a server
- a proxy
Client setup
There is only one configuration file- etc/client-config.xml
This is a self-described xml file. If you only want to test lucane with the client and server on the same host, you don't need to change anything here.
Here is a description of all parameters : (bold means mandatory)
- server : the server to use (host and port)
- login : the default login to display in the connection box
- language : the locale to use (en, fr, ..). You can set up a special font here
- proxy : only useful if you not in the same network than the server
- listener : used to force the use of a special port for the listener (if you are behing a firewall for example)
- public-ip : only useful to set which network interface to use if you have more than one
Once the configuration file is customized, you can start the client by "client.sh" or "client.bat". The server should of course be connected.
The client will automatically download the applications you can use. They'll be updated every time it will be needed without any client-side intervention
Server setup
The server is also easy to install, the main configuration file is :- etc/server-config.xml
Here is a description of all parameters : (bold means mandatory)
- database
- jdbc : the driver to use
- dblayer : the database abstraction layer to use
- pool : connection pool options
- store : the backend to use to store user, groups, plugins and services
- authenticator : the class to use for authentication
The databases engines tested are HSQLdb, MySQL and Postgres.
SQL Server has been reported to work.
The others haven't been tested
and aren't activated in the default distribution.
If you don't want to use a custom database, leave the config file as
it is to use HSQLdb.
The store can use the database or a ldap server. To use ldap, see the ldap store guide.
There are two authenticators :
- org.lucane.server.auth.DefaultAuthenticator : Nothing particular
- org.lucane.server.auth.LockingAuthenticator : locks user accounts after 3 login failures
You can start the server by "server.sh" or "server.bat".
Proxy setup
You will only need the proxy if you have several networks that aren't directly visible. This is the case if you are using NAT for example. The proxy does not need any configuration. Simply start it on the gateway by typing "proxy.sh" or "proxy.bat".
System configuration
To administrate the newly installed system, you will have to connect with the admin username and admin for password. The first thing to do will be to change this password. You will be able to start the administration interface and create users, groups, and give them the rights they need. Please take a look at the administration interface help for more information. That's rather straightforward.
User accounts available by default
Several accounts are available for testing purposes :
- admin : admin
- guest : guest