source: extensions/net.sf.basedb.ftp/trunk/README @ 987

Last change on this file since 987 was 985, checked in by Nicklas Nordborg, 14 years ago

Fixes #127: Update to final release of Apache Mina FTP server

  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.1 KB
[714]1== Requirements ==
[985]3 1. BASE 2.10.0 or later.
5== Introduction ==
7This package is an extension package to BASE that installs a small FTP
[985]8server as part of the web server. It uses the Apache FTP Server library
9for the actual handling of the FTP protcol.
11 * The homepage for this extension:
13 * The Apache FTP server site:
16== Installation ==
18 1. Download the `base-ftpserver-*.tar.gz` file.
19 2. Unpack the downloaded file to a directory of your choice.
[741]20 3. Copy the `ftp-config.xml` file to `WEB-INF/classes` directory.
21 4. The default `ftp-config.xml` file creates a regular FTP service with the
22    control connection on port 2121. There is also an example of an
23    SSL-enabled configuration. For more information about configuration
24    options see: 
[714]25 5. Copy the `base-ftpserver.jar` file and the `lib` directory, including sub-
26    directories and files, to your BASE extensions directory, `WEB-INF/extensions`.
[717]27 6. Run the `Extensions -> Manual scan` command to install the extension. If you
[714]28    have enabled automatic installation, just sit back and wait for it to find
29    the FTP server extension.
30 7. The FTP Server should now be running, but it only allows the root user to
31    login. To enable other users to login you have to start an FTP client, connect
32    to your BASE FTP server and login as root. This will register the FTP server
33    as a new client application that is shared to `Everyone`. To limit which users
34    that can access the FTP server go to `Adminstrate -> Clients` and change the
35    sharing options for the FTP Server.
36 8. Done.
[741]38== Known issues ==
[717]40 * BASE allows that a directory has the same name as a file. This may confuse
41   FTP clients since that is normally not allowed. The result for certain
42   operations is undefined for files and directories that has the same name.
[741]44== Tips and tricks ==
46 * If you want to try out an SSL enabled FTP server, but doesn't have
47   a certificate, you may create one with the following command:
49   `keytool -genkey -keystore test.jks -storetype JKS -storepass test -keypass test  -alias test`
[714]51== Compiling ==
53To compile this package you also need:
55 1. Ant 1.6
56 2. Java 1.6
58Follow these instructions:
60 1. Download the source code from the subversion repository. See
61 for instructions.
63 2. Type `ant download-lib` to automatically download the BASE core JAR file that
64    are neeed for compilation. You can also do this manually by copying the
65    BASE2Core.jar and BASE2Webclient.jar from the BASE installation directory
66    (`<basedir>/www/WEB-INF/lib/`) to the `./lib/compile` directory.
68 3. Type `ant` to compile the code and generate the `base-ftpserver.jar` file
69    in the project directory.
71 4. Use `ant package` to create a downloadable tar.gz package.
73Tip: If you need different values for any of the properties defined in
74the 'build.xml' file, create a file named '' and set
75the values there.
Note: See TracBrowser for help on using the repository browser.