From 8193052f13b6d086459e72aa528981f618315d18 Mon Sep 17 00:00:00 2001 From: mguessan Date: Fri, 7 Aug 2009 10:26:29 +0000 Subject: [PATCH] Doc: upgrade maven site plugin and improve style git-svn-id: http://svn.code.sf.net/p/davmail/code/trunk@655 3d1905a2-6b24-0410-a738-b14d5a86fcbd --- pom.xml | 17 ++ src/site/resources/css/site.css | 43 ++++ src/site/site.xml | 8 +- src/site/xdoc/faq.xml | 35 +-- src/site/xdoc/gettingstarted.xml | 245 ++++++++++---------- src/site/xdoc/index.xml | 11 +- src/site/xdoc/linuxsetup.xml | 15 +- src/site/xdoc/macosxsetup.xml | 12 +- src/site/xdoc/osxdirectorysetup.xml | 27 +-- src/site/xdoc/osxicalsetup.xml | 21 +- src/site/xdoc/osximapmailsetup.xml | 42 ++-- src/site/xdoc/serversetup.xml | 11 +- src/site/xdoc/thunderbirdcalendarsetup.xml | 19 +- src/site/xdoc/thunderbirddirectorysetup.xml | 15 +- src/site/xdoc/thunderbirdimapmailsetup.xml | 27 +-- src/site/xdoc/thunderbirdmailsetup.xml | 27 +-- src/site/xdoc/windowssetup.xml | 15 +- 17 files changed, 337 insertions(+), 253 deletions(-) create mode 100644 src/site/resources/css/site.css diff --git a/pom.xml b/pom.xml index 4a6fb969..ede26d74 100644 --- a/pom.xml +++ b/pom.xml @@ -7,6 +7,9 @@ jar 3.3.0 DavMail POP/IMAP/SMTP/Caldav/LDAP Exchange Gateway + + Mickaël Guessant + http://www.sourceforge.net/projects/davmail 2001 @@ -224,6 +227,15 @@ 3.2.7 + + + apache.snapshots + http://repository.apache.org/snapshots + + false + + + src/java @@ -235,6 +247,11 @@ 1.5 + + org.apache.maven.plugins + maven-site-plugin + 2.1-SNAPSHOT + diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css new file mode 100644 index 00000000..d6a56c88 --- /dev/null +++ b/src/site/resources/css/site.css @@ -0,0 +1,43 @@ +/* You can override this file with your own styles */ +.externalLink img { + vertical-align: middle; +} +.section h2, .section h3 { + border:0px; + background: transparent; + color:black; + font-size:17px; +} +.section h2 { + border-bottom:1px solid; + padding:1px; +} +.section h3 { + background:#ECECEC; + font-size:15px; + font-weight:bold; +} +.section p { + padding-left:15px; +} + + + +.section table { + margin-left:10px; + border-collapse: collapse; +} +.small { + font-size:9px; +} +.source { + overflow:auto; +} +.floatLeft { + float:left; +} +.notype { + list-style-type:none; + margin-left:10px; + padding-left:0px; +} \ No newline at end of file diff --git a/src/site/site.xml b/src/site/site.xml index 1bf42c47..4b26aab5 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -1,7 +1,9 @@ - + - + SourceForge http://sflogo.sourceforge.net/sflogo.php?group_id=184600&type=12 @@ -17,7 +19,7 @@ - + diff --git a/src/site/xdoc/faq.xml b/src/site/xdoc/faq.xml index fcdfa830..d987abb7 100644 --- a/src/site/xdoc/faq.xml +++ b/src/site/xdoc/faq.xml @@ -1,5 +1,7 @@ - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Frequently asked questions @@ -11,7 +13,7 @@

Frequently asked questions on DavMail forums, mailing list or direct email.

-
+

Authentication fails with invalid user or password message

@@ -34,9 +36,9 @@

Your Exchange server expects HTTPS (secured) connections, use https instead of http in OWA url.

-
+ -
+

How do I detect errors in Thunderbird/Lightning calendar ?

@@ -44,9 +46,9 @@ on. To detect errors at this level, you may activate calendar log settings under Tools/Options/Advanced:

- calendar.debug.log=true - calendar.debug.log.verbose=true - + +calendar.debug.log=true +calendar.debug.log.verbose=true

Invalid notifications @@ -59,22 +61,27 @@

calendar.caldav.sched.enabled=true -
+ -
+

How to build DavMail ?

Building DavMail is quite simple:

  • Make sure you have Java 6 installed and set as current version by checking - JAVA_HOME:
    + JAVA_HOME: +
      -
    • Unix/OSX: echo $JAVA_HOME
      • -
    • Windows: echo %JAVA_HOME%
      • +
    • Unix/OSX: + echo $JAVA_HOME +
      • +
    • Windows: + echo %JAVA_HOME% +
    • -
  • Download and unzip ant fromant.apache.org, +
  • Download and unzip ant from ant.apache.org, add ant/bin full path to the PATH environment variable
  • Get DavMail source package from sourceforge and uncompress it: @@ -89,7 +96,7 @@

Packages are then available under dist

-
+
\ No newline at end of file diff --git a/src/site/xdoc/gettingstarted.xml b/src/site/xdoc/gettingstarted.xml index 4291c198..bb73ffa2 100644 --- a/src/site/xdoc/gettingstarted.xml +++ b/src/site/xdoc/gettingstarted.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Getting started @@ -15,128 +16,126 @@ Settings...

- +
-

- The following table describes the main and advanced options : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescriptionSample value
OWA urlOutlook Web Access URL to access the exchange server, i.e. the base webmail URLhttp://exchangeServer/exchange/
Local POP portLocal POP server port to configure in POP client110
Local IMAP portLocal IMAP server port to configure in IMAP client143
Local SMTP portLocal SMTP server port to configure in POP client25
Local Caldav HTTP portLocal Caldav server port to configure in Caldav (calendar) client80
Local LDAP portLocal LDAP server port to configure in add directory (addresse book) client389
Keep DelayNumber of days to keep messages in Exchange trash folder before actual deletion30
Sent Keep DelayNumber of days to keep sent messages in Exchange sent folder90
Calendar past eventsGet events in the past not older than specified days count, leave empty for no limits90
Allow remote connectionsAllow remote connections to the gateway (server mode)false
Key store typeChoose key store typeJKS
Key storeSSL certificate key store file pathpath/to/keystore
Key store passwordKey store passwordpassword
Key passwordSSL key password inside key storepassword
PKCS11 libraryPKCS11 (smartcard) library path (.so or .dll)softokn3.dll
PKCS11 configOptional additional PKCS11 settings (slot, nssArgs, ...)slot=2
Bind AddressBind only to the specified network address10.0.1.2
Server certificate hashManually accepted server certificate hash, contains the SHA1 hash of - a manually accepted certificate (invalid or self signed) - 9F:CC:59:82:1F:C:CD:29:7C:70:F0:D8:37:B1:77:3F:48:84:AE:C4
Disable update checkDisable DavMail check for new versionfalse
Logging levelsDefault, DavMail and HttpClient logging levels, see Log4J documentation for more details - WARN
Log file PathDavMail log file path (default is davmail.log in working directory on Unix and Windows, - ~/Library/Logs/DavMail/davmail.log on OSX) - davmail.log
-

+

The following table describes the main and advanced options :

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescriptionSample value
OWA urlOutlook Web Access URL to access the exchange server, i.e. the base webmail URLhttp://exchangeServer/exchange/
Local POP portLocal POP server port to configure in POP client110
Local IMAP portLocal IMAP server port to configure in IMAP client143
Local SMTP portLocal SMTP server port to configure in POP client25
Local Caldav HTTP portLocal Caldav server port to configure in Caldav (calendar) client80
Local LDAP portLocal LDAP server port to configure in add directory (addresse book) client389
Keep DelayNumber of days to keep messages in Exchange trash folder before actual deletion30
Sent Keep DelayNumber of days to keep sent messages in Exchange sent folder90
Calendar past eventsGet events in the past not older than specified days count, leave empty for no limits90
Allow remote connectionsAllow remote connections to the gateway (server mode)false
Key store typeChoose key store typeJKS
Key storeSSL certificate key store file pathpath/to/keystore
Key store passwordKey store passwordpassword
Key passwordSSL key password inside key storepassword
PKCS11 libraryPKCS11 (smartcard) library path (.so or .dll)softokn3.dll
PKCS11 configOptional additional PKCS11 settings (slot, nssArgs, ...)slot=2
Bind AddressBind only to the specified network address10.0.1.2
Server certificate hashManually accepted server certificate hash, contains the SHA1 hash of + a manually accepted certificate (invalid or self signed) + 9F:CC:59:82:1F:C:CD:29:7C:70:F0:D8:37:B1:77:3F:48:84:AE:C4
Disable update checkDisable DavMail check for new versionfalse
Logging levelsDefault, DavMail and HttpClient logging levels, see Log4J documentation for more details + WARN
Log file PathDavMail log file path (default is davmail.log in working directory on Unix and Windows, + ~/Library/Logs/DavMail/davmail.log on OSX) + davmail.log

Uncheck a port to disable matching service.

Activate panel under Proxy tab to set an HTTP proxy and associated credentials if needed

Proceeed to diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 600a9f11..f895fa3b 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway @@ -8,9 +9,9 @@ - +

Ever wanted to get rid of Outlook ? DavMail is a POP/IMAP/SMTP/Caldav/LDAP exchange gateway allowing @@ -23,7 +24,7 @@ Tested successfully with the Iphone (gateway running on a server).

- +
diff --git a/src/site/xdoc/linuxsetup.xml b/src/site/xdoc/linuxsetup.xml index 3c7f4c5d..2aedffdb 100644 --- a/src/site/xdoc/linuxsetup.xml +++ b/src/site/xdoc/linuxsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Linux setup @@ -10,7 +11,7 @@
-
+

Download current debian package from Sourceforge, double click on it to launch package installer.

@@ -19,8 +20,8 @@ install sun-java6-bin and the appropriate swt package. After installation, DavMail is available in the Applications menu.

-
-
+ +

Prerequisite : Sun J2SE 1.5 or 1.6. Tray icon is now implemented with SWT and compatible with Java 1.5.

@@ -46,12 +47,12 @@ You should now see the DavMail gateway icon in the tray :

- +

Adjust DavMail settings : Getting started

-
+
diff --git a/src/site/xdoc/macosxsetup.xml b/src/site/xdoc/macosxsetup.xml index f07098bf..94805cce 100644 --- a/src/site/xdoc/macosxsetup.xml +++ b/src/site/xdoc/macosxsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Mac OS X setup @@ -17,16 +18,17 @@

Download DavMail Mac OSX package from Sourceforge:

- +

Safari should automatically extract the application archive. If not, just double click on the zip file to trigger decompression. The extracted DavMail.app directory is then recognised as a valid OSX application.

Just double click on the application icon to launch DavMail. On - first start the application displays the Settings (Preferences) frame.

+ first start the application displays the Settings (Preferences) frame. +

- +

Adjust DavMail settings: Getting started diff --git a/src/site/xdoc/osxdirectorysetup.xml b/src/site/xdoc/osxdirectorysetup.xml index de048f9b..5667c9cc 100644 --- a/src/site/xdoc/osxdirectorysetup.xml +++ b/src/site/xdoc/osxdirectorysetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - OSX directory setup @@ -14,68 +15,68 @@ A special OpenDirectory naming context was implemented to enable iCal attendee completion.

-
+

In OSX Finder, go to Utilities and launch Directory Utility:

- +

Choose Show Advanced Settings, switch to Services tab, select LDAPv3 and click the pencil icon (you may need to unlock settings with your admin password first):

- +

Click New...:

- +

Enter DavMail server name (localhost) and click Manual:

- +

Enter Configuration Name and choose OpenDirectory in LDAP Mappings:

- +

Enter o=od as Search Base Suffix:

- +

If DavMail LDAP listen port is not 389, edit the new configuration, check Use custom port and enter actual port:

- +

Then activate authentication under the Security tab and enter your credentials:

- +

Under the Search Policy tab, choose Contacts, set Search to Custom Path and /LDAPV3/localhost to the list of Directory Domains:

- +

Proceeed to OSX IMAP Mail setup

-
+
\ No newline at end of file diff --git a/src/site/xdoc/osxicalsetup.xml b/src/site/xdoc/osxicalsetup.xml index ecdfa913..ac845098 100644 --- a/src/site/xdoc/osxicalsetup.xml +++ b/src/site/xdoc/osxicalsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - OSX iCal setup @@ -14,32 +15,34 @@ This should also work with other Caldav clients.

-
+

Open iCal Preferences, go to the Accounts tab and click the plus button:

- +

Choose a name, enter you Exchange username and password. Open the server options section - to enter the full calendar URL (adjust port to your settings):

+ to enter the full calendar URL (adjust port to your settings): +

http://localhost:1080/principals/users/mail@company.com

Replace mail@company.com with actual user email address.

- +

Click Add, choose Connect Anyway in warning dialog:

- +

Proceeed to - OSX directory setup to enable attendee completion. + OSX directory setup + to enable attendee completion.

-
+ \ No newline at end of file diff --git a/src/site/xdoc/osximapmailsetup.xml b/src/site/xdoc/osximapmailsetup.xml index 4693d931..858ba75a 100644 --- a/src/site/xdoc/osximapmailsetup.xml +++ b/src/site/xdoc/osximapmailsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - OSX IMAP Mail setup @@ -16,88 +17,89 @@ than POP. This page describes OSX IMAP Mail setup.

-
+

Launch Apple Mail, open Preferences and click the plus button to create a new - account. Enter you full name, email address and password:

+ account. Enter you full name, email address and password: +

- +

Choose IMAP account type, enter description, DavMail gateway address (localhost). Check username and password:

- +

Click continue, if DavMail is not listening on the default IMAP port (143), you will get the following error message, click Continue again to proceed:

- +

Leave SSL unchecked and click Continue:

- +

Enter Outgoing Mail Server (SMTP) description and DavMail gateway address (localhost). Check Use Authentication and enter your Exchange username and password:

- +

Click continue, if DavMail is not listening on the default SMTP port (25), you will get the following error message, click Continue again to proceed:

- +

Leave SSL unchecked and click Continue:

- +

Check summary and click Create:

- +
-
-
+ +

Open the Mailbox Behaviors tab and uncheck Store sent messages on server, as Exchange already stores each sent message in this folder:

- +

Under the advanced tab, enter actual DavMail IMAP port:

- +

Under the Account Information tab, choose Edit Server List in Outgoing Mail Server (SMTP) field:

- +

Open the advanced tab, check use custom port and enter actual DavMail SMTP port:

- +

You may also want to set the Add invitations to iCal parameter to Never:

- +
-
+ \ No newline at end of file diff --git a/src/site/xdoc/serversetup.xml b/src/site/xdoc/serversetup.xml index aceb5fb9..c19b4261 100644 --- a/src/site/xdoc/serversetup.xml +++ b/src/site/xdoc/serversetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Server setup @@ -71,7 +72,7 @@ davmail.logFilePath=/var/log/davmail.log
-

Prerequisites : Sun J2SE 1.5 or 1.6 and any JEE compliant web container +

Prerequisites : Sun J2SE 1.5 or 1.6 and any JEE compliant web container

Davmail Gateway can now be deployed in any JEE application server using @@ -81,7 +82,7 @@ davmail.logFilePath=/var/log/davmail.log details will vary according to the specific application server available.

-

Download the war DavMail package from Sourceforge davmail-*.war, +

Download the war DavMail package from Sourceforgedavmail-*.war, and deploy it inside the application server. In Tomcat, this means copy the war file to the webapps directory. If Tomcat is started and automatic deployment enabled (this is the default configuration), the package is @@ -90,7 +91,7 @@ davmail.logFilePath=/var/log/davmail.log

The davmail.properties configuration file is then available under davmail-*/WEB-INF/classes.

- +

See above and Getting started for more information on diff --git a/src/site/xdoc/thunderbirdcalendarsetup.xml b/src/site/xdoc/thunderbirdcalendarsetup.xml index 3df82c04..892165c5 100644 --- a/src/site/xdoc/thunderbirdcalendarsetup.xml +++ b/src/site/xdoc/thunderbirdcalendarsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Thunderbird calendar setup @@ -14,12 +15,12 @@ This should also work with other Caldav clients.

-
+

Obviously, you need to install the Thunderbird Lightning extension. You can then create a new network calendar:

- +

Choose CalDav format and specify location (adjust port to your settings):

@@ -28,27 +29,27 @@

Replace mail@company.com with actual user email address.

- +

Choose a name, color and set the associated email address (as set in mail setup)

- +

Provide your credentials, login is Active Directory account name, i.e. domain\account

- +

Finish:

- +

You may want to enable the (experimental) Lightning calendar cach feature to avoid @@ -59,7 +60,7 @@

Proceeed to Thunderbird directory setup

-
+
\ No newline at end of file diff --git a/src/site/xdoc/thunderbirddirectorysetup.xml b/src/site/xdoc/thunderbirddirectorysetup.xml index ab4ba5bc..bdd55de1 100644 --- a/src/site/xdoc/thunderbirddirectorysetup.xml +++ b/src/site/xdoc/thunderbirddirectorysetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Thunderbird directory setup @@ -13,22 +14,22 @@

DavMail Directory support is now available to access Exchange address book through LDAP.

-
+

Open Thunderbird address book and choose File/New/LDAP Directory:

- +
-

Choose a name, host is always localhost, LDAP base context ou=people, +

Choose a name, host is always localhost, LDAP base contextou=people, adjust port to your settings and set user to your Active Directory account name, i.e. domain\account. Leave other options to default values.

You may also want to use this directory for mail completion in compoze window :

- +
-
+ \ No newline at end of file diff --git a/src/site/xdoc/thunderbirdimapmailsetup.xml b/src/site/xdoc/thunderbirdimapmailsetup.xml index 0fc9bcc8..e494f7b2 100644 --- a/src/site/xdoc/thunderbirdimapmailsetup.xml +++ b/src/site/xdoc/thunderbirdimapmailsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Thunderbird mail setup @@ -27,21 +28,21 @@ Thunderbird. DavMail IMAP support is tested with Thunderbird, Outlook and Apple Mail.

-
+
- +

Edit common name and Exchange mail address:

- +

Choose IMAP as server type, located at localhost:

- +
@@ -50,27 +51,27 @@ Exchange 2007.

- +

Edit account name (email address by default):

- +

Finish:

- +
-
-
+ +

Create a new outgoing mail configuration under account settings:

- +

Server name is localhost, edit port according to DavMail settings. The connection must use authentication with Active Directory account and encryption is not needed. @@ -78,7 +79,7 @@

Proceeed to Thunderbird calendar setup

-
+ \ No newline at end of file diff --git a/src/site/xdoc/thunderbirdmailsetup.xml b/src/site/xdoc/thunderbirdmailsetup.xml index 4a695ce2..da6a3c7e 100644 --- a/src/site/xdoc/thunderbirdmailsetup.xml +++ b/src/site/xdoc/thunderbirdmailsetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Thunderbird mail setup @@ -27,21 +28,21 @@ Thunderbird

-
+
- +

Edit common name and Exchange mail address:

- +

Choose POP as server type, located at localhost:

- +
@@ -50,27 +51,27 @@ Exchange 2007.

- +

Edit account name (email address by default):

- +

Finish:

- +
-
-
+ +

Create a new outgoing mail configuration under account settings:

- +

Server name is localhost, edit port according to DavMail settings. The connection must use authentication with Active Directory account and encryption is not needed. @@ -78,7 +79,7 @@

Proceeed to Thunderbird calendar setup

-
+ \ No newline at end of file diff --git a/src/site/xdoc/windowssetup.xml b/src/site/xdoc/windowssetup.xml index e1b9ce30..7821245d 100644 --- a/src/site/xdoc/windowssetup.xml +++ b/src/site/xdoc/windowssetup.xml @@ -1,6 +1,7 @@ - - + DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway - Windows setup @@ -24,27 +25,27 @@

Choose language:

- +

Click Next:

- +

Accept GPL licence:

- +

Choose path:

- +

Launch installation and start gateway:

- +

Adjust DavMail settings : Getting started