charlesb 01/05/09 13:35:42
Modified: . README
Log:
Updated to current start procedure
Revision Changes Path
1.15 +81 -73 jakarta-james/README
Index: README
===================================================================
RCS file: /home/cvs/jakarta-james/README,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- README 2001/01/15 22:34:50 1.14
+++ README 2001/05/09 20:35:38 1.15
@@ -1,21 +1,24 @@
- _J_A_V_A___A_P_A_C_H_E___M_A_I_L___E_N_T_E_R_P_R_I_S_E___S_E_R_V_E_R_
-
+ _J_A_K_A_R_T_A__J_A_M_E_S___M_A_I_L__S_E_R_V_E_R
+
What is it?
-----------
- The Java Apache Mail Enterprise Server (a.k.a. Apache James) is a 100% pure
- Java server application designed to be a complete, portable and powerful
- enterprise mail engine solution based on currently available open protocols
- (SMTP, POP3, IMAP, HTTP etc).
+ JAMES is a 100% pure Java server application designed to be a complete,
+ portable and powerful enterprise mail engine solution based on currently
+ available open protocols (SMTP, POP3, IMAP, NNTP etc).
- Development Status for JAMES 1.2.1
+ JAMES was formerly known as the Java Apache Mail Enterprise Server.
+
+ Development Status for JAMES 1.2.2
----------------------------------
SMTP Server: Stable
POP3 Server: Beta
+ IMAP Server:
+ NNTP Server:
Current Feature
----------------
@@ -78,18 +81,10 @@
Requirements
------------
- - JAMES.jar (of course).
- - mailet.jar
- - javax package (activation.jar, mail.jar)
- - Avalon server framework including:
- Avalon.jar
- AvalonAware.jar
- Loader.jar
- Xerces.jar (or any other SAX capable XML Parser).
- - dnsjava.jar
- - town.jar (optional - for RDBMS storage)
+ - JAMES.sar (required)
+ - Phoenix server (Jakarta-Avalon-Phoenix) (required)
- JAMES distribution includes all of the above.
+ JAMES distribution includes both required items.
To recompile James from sources you should use org.apache.tools.ant and its
needed packages (ant.jar, javac.jar, xml.jar).
@@ -97,70 +92,83 @@
Up and working...
-----------------
-Step 0: building. (only necessary for daily snapshots)
-
- If you have downloaded a regular distribution, you do not need to
- build James. Proceed directory to Step 1.
-
- If you have downloaded a daily snapshot, you need to build a
- distribution. James uses ant (http://jakarta.apache.org/ant/) to
- compile and package its distribution. Once you have installed ant,
- extracted the snapshot to your favorite folder, cd to that folder
- and run the "dist" task by calling "ant dist". This will create the
- distribution in the "./dist" folder as well as create .tgz and .zip
- copies of this folder. This "./dist" folder is the distribution
- folder used in Step 1 and beyond. You may either cd to ./dist, or
- you may copy and rename the dist folder to your new favorite folder.
-
Step 1: installation.
- Download distibution. Extract all files in your favorite folder.
-
-Step 2: configuration.
+ Download distibution. Extract all files in your favorite folder. You've
+ probably done that if you are reading this file!
- Read the short and snappy documentation at docs/index.html for a proper
- overview of configuring the system.
-Summary (for impatient people)
-
+Step 2: start phoenix.
+
M$ users should just run /bin/run.bat. Unix users will find run.sh
- under the same folder. A JVM must be in the path.
- Running [run* -help] will provide a simple command line help.
+ under the same folder - you may need to chmod +x run.sh. A JVM must be in
+ the path.
+
+ Phoenix will unpack the james.sar into apps/james. Note that port 1111
+ must be available for Phoenix to run (used by RMI server).
Most UNIX systems require superuser privileges to open sockets below 1024,
- which includes the IANA-standard SMTP (on port 25) and POP3 (on port 110).
- These default ports can be changed in the conf.xml file. (Obviously, you
- would then need to reconfigure your clients. This may not be an option if
- you want to receive mail from external mailservers.)
-
- The Avalon framework will unpack the neccessay configuration files and wait
- for you to configure them. For basic use, you only need to set two items
- in the JAMES.conf.xml file: a root password for the remote administration
- facility and the IP address of a DNS server. Once you have edited the
- configuration files, press 'Enter' on the terminal where Avalon is waiting.
-
-Step 4: kickstart.
-
- Once started you'll see a message saying Avalon is running. This means that
- Avalon has loaded JAMES and every other needed Block (see /logs/avalon.log)
- and is now waiting for a socket request.
- Since at the beginning James is empty, it will not have any local users
- registered.
- To register a local user open a telnet session with localhost on port 4555,
- log in as root ("root[enter] <password-you-set-in-conf.xml>[enter]") and
- type "help" for a list of available commands in the "JAMES remote
- administrator tool". It is really a basic set but should allow you to test
- installation.
-
- Once you have some local users registered, try sending mail to one of them
- @localhost with SMTP (port 25) (assuming you have not changed the default
- server names in the conf.xml file). You'll see the mail appear under
- ../var/mail/localinbox/[user].
- Try now to retrieve that mail using POP3 (port 110).
+ which includes the IANA-standard SMTP (on port 25), POP3 (on port 110),
+ IMAP (port ) and NNTP (port ). You will get an error message with
+ 'org.apache.avalon.framework.atlantis.ApplicationException: Failed to
+ load block imapserver'
+ or something similar if you have not got the right privileges.
+
+ If you have the right privileges, you should see
+
+ 'Phoenix 3.1a1-dev
+
+ James James 1.2.2 Alpha
+ Started IMAP Server plain:143
+ Started NNTP Server plain:119
+ Started SMTP Server plain:25
+ Started POP3 Server plain:110'
+
+ Congratulations! You have James up and running.
+
+Step 3: Adding users
+
+ Once James is running, telnet to port 4555. You will see somthing like:
+ 'JAMES RemoteAdministration Tool 1.2.2alpha
+ Please enter your login and password
+ Login id:'
+
+ The defaul id and password are both 'root'. These can be changed in
+ the configuration file (see Step 4).
+
+ To get help for the RemoteAdmin tool, type help. To add a user, type
+ adduser [username] [password] .
+ Eg: adduser test test
+
+
+Step 4: Test James
+
+ Once you have some users entered, you can test James by sending mail to
+ them. Note that for mail to get to your machine, you need MX records in
+ the DNS system. You will see files materialise in
+ apps/james/var/mail/inboxes.
+
+ Retrieve the mail by configuring your POP client to get mail (inbound mail
+ server) from James.
+
+ Test outbound mail handling by configuring your client to use James smtp.
+ (By default, you can only send mail from the machine on which James is
+ running. This is to stop spam relaying. This can be changed in config
+ file.)
+
Trace out JAMES actions in /logs/*info.log.
Action that will be taken by JAMES on incoming mail are configurated in
the mailet pipe line (/conf/james.conf.xml). Look at it if you want to
understand what's happening.
+
+Step 5: configuration.
+
+ The configuration files are in apps/james/conf. For new users, the only
+ elements you need to worry about are in config.xml. You probably want to
+ change the root password in the remote manager section and to add your
+ local network's IP address to the anti-spam mailet.
+
+
Good luck :)
@@ -173,5 +181,5 @@
Thanks.
- The Java Apache Project
- http://java.apache.org/
+ The Jakarta Project
+ http://jakarta.apache.org/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
