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

Last change on this file since 1439 was 1439, checked in by Nicklas Nordborg, 11 years ago

Preparing 'FTP Server 1.2' release.

  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.6 KB
RevLine 
[714]1== Requirements ==
2
[1382]3 1. BASE 3.0 or later.
[714]4 
5== Introduction ==
6
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
[1382]9for the actual handling of the FTP protocol.
[714]10
11 * The homepage for this extension:
12   http://baseplugins.thep.lu.se/wiki/net.sf.basedb.ftp
13 * The Apache FTP server site:
[741]14   http://mina.apache.org/ftpserver/index.html
[714]15
16== Installation ==
17
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: http://mina.apache.org/ftpserver/documentation.html 
[1382]25 5. Copy the 'base-ftpserver.jar' file to your BASE plug-ins directory.
[1439]26   Look in your 'base.config' file if you don't know where this is.
[1382]27 6. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
28 7. Run the installation wizard and select to install 'base-ftpserver.jar'.
29 8. The FTP Server should now be running, but it only allows the root user to
[714]30    login. To enable other users to login you have to start an FTP client, connect
31    to your BASE FTP server and login as root. This will register the FTP server
32    as a new client application that is shared to `Everyone`. To limit which users
[1382]33    that can access the FTP server go to `Administrate -> Clients` and change the
[714]34    sharing options for the FTP Server.
[1382]35 9. Done.
[714]36
[741]37== Known issues ==
[714]38
[717]39 * BASE allows that a directory has the same name as a file. This may confuse
40   FTP clients since that is normally not allowed. The result for certain
41   operations is undefined for files and directories that has the same name.
[1382]42 * BASE-files that are a link to an external URL will show up as read-only in
43   the FTP-server. If the file size of an external file is not known it is
44   shown as 0 in the FTP server.
[1225]45 
[741]46== Tips and tricks ==
47
[1399]48 * To activate a project when logging in via FTP, use a login name like
49   `username<projectname>`, where `username` is the usual login and
50   `projectname` is the name of the project to set active. This is useful
51   to access files that has been shared to a project, but note that
52   the path must be accessible all they way from the root. If no project
53   with the given name can be found, the user is logged in without an
54   active project.
55
[741]56 * If you want to try out an SSL enabled FTP server, but doesn't have
57   a certificate, you may create one with the following command:
58   
59   `keytool -genkey -keystore test.jks -storetype JKS -storepass test -keypass test  -alias test`
60
[714]61== Compiling ==
62
63To compile this package you also need:
64 
[1439]65 1. Ant 1.8
[714]66 2. Java 1.6
67
68Follow these instructions:
69
70 1. Download the source code from the subversion repository. See
71    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.ftp for instructions.
72 
73 2. Type `ant download-lib` to automatically download the BASE core JAR file that
74    are neeed for compilation. You can also do this manually by copying the
[1382]75    base-core-3.0.0.jar and base-webclient-3.0.0.jar from the BASE installation directory
[714]76    (`<basedir>/www/WEB-INF/lib/`) to the `./lib/compile` directory.
77
78 3. Type `ant` to compile the code and generate the `base-ftpserver.jar` file
79    in the project directory.
80
81 4. Use `ant package` to create a downloadable tar.gz package.
82 
83Tip: If you need different values for any of the properties defined in
84the 'build.xml' file, create a file named 'build.properties' and set
85the values there.
Note: See TracBrowser for help on using the repository browser.