by SuperBonBon

Installation

Installation home  > Required software to run JAFS  > JAFS structure  > Configuration files  > JAFS startup  > Administration console 

Installation home

Welcome to the JAFS server installation guide. This software can be used on any java 1.4 compatible OS such as windows and linux. The following guide will help you install and configure the FTP server.

Required software to run JAFS

• A 1.4 java runtime environment (JRE). This server has been tested with IBM 1.4 ( linux only ) and SUN 1.4.1,1.4.2 JRE's ( SUN 1.4.0 JRE not recommanded ).
  This software is unfortunately uncompatible with previous JRE versions.
  You can find SUN 1.4.x JRE here
  and IBM JRE here
• When you are done with JRE installation, you'll have to set the JAVA_HOME system variable with your JRE installation path ( I.E c:\Program Files\j2sdk1.4.x ), If you don't know how to do it, here is a short guide for windows. I assume that linux users know how to do it :o)
• If no JAVA_HOME is provided the default java binary ( if available ) will be used for execution

JAFS structure

A small description of JAFS directory structure

• bin : Where the JAFS startup files are located as well as the SSL certificate generation file executables and system service installation/removal files
• config : The location of all XML configuration file for JAFS ( JAFS service, ftp servers, scripts, xml authentication relam, log4j )
  • ssl : The directory where the SSL certificate store and the server certificate request (certificate.csr) are stored
• datastore : Where some files will be stored to keep some server specific informations ( banned clients, credits for clients ), make sure to backup this directory if you're planning to reinstall JAFS
• docs : Documentation directory
  • html : The Server main documentation
  • api : The Server API javadoc
• libs : Contains all the external libraries and the JAFS library.
• logs : JAFS log files such as servers logs jafs services log and system service file. Finally this directory contains the clients activity log files

Configuration files

All the configuration files are located into the "config" directory. Here is a small description of the JAFS configuration files

• logs_config.xml : This is the logging configuration file for errors and other server activity logging, you do not have to modify this file.
• scripts.xml : This file contains some variable that can be used in server messages ( welcome message for example ).
• service_config.xml : is the JAFS service configuration file, this configuration file contains some generic configuration parameters such as the administration console port.
• xml_auth_realm.xml : This file contains all the user names and passwords that will be used by deployed servers, you'll need to edit this file to add/remove users.
• server_sample.xml : This file contains a ftp server sample configuration file, since JAFS can handle multiple server instances, each server has its own configuration file.

All those configuration files are in XML format, if you've never heard about from XML, you can read our small XML guide

JAFS startup

You can try to startup JAFS with the default configuration as following :

• execute bin/JAFS.bat under windows or bin/JAFS.sh under linux, it should normally start.
• The current JAFS ftp/pub directory on port 2121 will be exposed, this link should normally work with your favorite browser.

You can now edit the service_config.xml file to match your system setting and create as many server as you want using the JAFS server XML grammar.

You can also use the administration console createServer operation if you want to create a new server without touching XML.

Take a look at the setup guide for more informations about how to change settings in the configuration files.

If some error occurs after you have edited a configuration file, read the error message in the window, it should normally be detailed enough to let you figure out your configuration mistake. It can be either a problem in the service_config.xml configuration file or a problem during a server deployment

If you really can't make it work with the default settings, go take a look at the forums to see if someone has experienced the same problem, if not then fill out a bug report with the JAFS bug report forum thread.

Administration console

You can access the administration console here using user:administrator password:administrator if you do not have altered setting related to the console in service_config.xml