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

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

References #114: Implement FTP Server

Initial checkin.

File size: 3.1 KB
Line 
1== Requirements ==
2
3 1. BASE 2.8.0 or later.
4 
5== Introduction ==
6
7This package is an extension package to BASE that installs a small FTP
8server as part of the web server. The code in this package currently
9uses non-released software from the Apache foundation. Thus, we can't make
10any guarantee about functionality or stability of this extension. We recommend
11testing on a development server before using this software in a production
12environment. For the same reason we can't make any promises about API
13compatibility between releases. The API may change at any time.
14
15 * The homepage for this extension:
16   http://baseplugins.thep.lu.se/wiki/net.sf.basedb.ftp
17 * The Apache FTP server site:
18   http://mina.apache.org/ftpserver.html
19
20== Installation ==
21
22 1. Download the `base-ftpserver-*.tar.gz` file.
23 2. Unpack the downloaded file to a directory of your choice.
24 3. Copy the `ftp.config` file to `WEB-INF/classes` directory.
25 4. The default `ftp.config` file creates a regular FTP service on port 2121.
26    If you want to use a different port, and/or change other settings edit
27    the `ftp.config` file. For more information about configuration options see:
28    http://mina.apache.org/ftpserver-documentation.html
29 5. Copy the `base-ftpserver.jar` file and the `lib` directory, including sub-
30    directories and files, to your BASE extensions directory, `WEB-INF/extensions`.
31 6. Run the 'Extensions -> Manual scan' command to install the extension. If you
32    have enabled automatic installation, just sit back and wait for it to find
33    the FTP server extension.
34 7. The FTP Server should now be running, but it only allows the root user to
35    login. To enable other users to login you have to start an FTP client, connect
36    to your BASE FTP server and login as root. This will register the FTP server
37    as a new client application that is shared to `Everyone`. To limit which users
38    that can access the FTP server go to `Adminstrate -> Clients` and change the
39    sharing options for the FTP Server.
40 8. Done.
41
42== Known issues / limitation ==
43
44 * It is not possible to specify a `user-manager` or `file-system-manager`
45   in the `ftp.config` file. Those settings will be replaced by BASE-specific
46   options.
47
48== Compiling ==
49
50To compile this package you also need:
51 
52 1. Ant 1.6
53 2. Java 1.6
54
55Follow these instructions:
56
57 1. Download the source code from the subversion repository. See
58    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.ftp for instructions.
59 
60 2. Type `ant download-lib` to automatically download the BASE core JAR file that
61    are neeed for compilation. You can also do this manually by copying the
62    BASE2Core.jar and BASE2Webclient.jar from the BASE installation directory
63    (`<basedir>/www/WEB-INF/lib/`) to the `./lib/compile` directory.
64
65 3. Type `ant` to compile the code and generate the `base-ftpserver.jar` file
66    in the project directory.
67
68 4. Use `ant package` to create a downloadable tar.gz package.
69 
70Tip: If you need different values for any of the properties defined in
71the 'build.xml' file, create a file named 'build.properties' and set
72the values there.
Note: See TracBrowser for help on using the repository browser.