Skip to content
Permalink
Browse files
Split the distributed server documentation
  • Loading branch information
chibenwa committed Oct 12, 2021
1 parent c16e4c6 commit 3295e78628953faeeb2eadd4038e56d901e94c24
Show file tree
Hide file tree
Showing 216 changed files with 450 additions and 253 deletions.
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
@@ -10,60 +10,4 @@
*** xref:basic/conf/index.adoc[]
*** xref:basic/help.adoc[]
** xref:extendable.adoc[]
** xref:distributed.adoc[]
*** xref:distributed/objectives.adoc[]
*** xref:distributed/architecture/index.adoc[]
**** xref:distributed/architecture/consistency-model.adoc[]
**** xref:distributed/architecture/specialized-instances.adoc[]
*** xref:distributed/run.adoc[]
*** xref:distributed/run-docker.adoc[]
*** xref:distributed/configure/index.adoc[]
**** Protocols
***** xref:distributed/configure/imap.adoc[imapserver.xml]
***** xref:distributed/configure/jmap.adoc[jmap.properties]
***** xref:distributed/configure/jmx.adoc[jmx.properties]
***** xref:distributed/configure/smtp.adoc[smtpserver.xml & lmtpserver.xml]
***** xref:distributed/configure/smtp-hooks.adoc[Packaged SMTP hooks]
***** xref:distributed/configure/pop3.adoc[pop3server.xml]
***** xref:distributed/configure/webadmin.adoc[webadmin.properties]
***** xref:distributed/configure/ssl.adoc[SSL & TLS]
**** Storage dependencies
***** xref:distributed/configure/blobstore.adoc[blobstore.properties]
***** xref:distributed/configure/cassandra.adoc[cassandra.properties]
***** xref:distributed/configure/elasticsearch.adoc[elasticsearch.properties]
***** xref:distributed/configure/rabbitmq.adoc[rabbitmq.properties]
***** xref:distributed/configure/tika.adoc[tika.properties]
**** Core components
***** xref:distributed/configure/batchsizes.adoc[batchsizes.properties]
***** xref:distributed/configure/dns.adoc[dnsservice.xml]
***** xref:distributed/configure/domainlist.adoc[domainlist.xml]
***** xref:distributed/configure/healthcheck.adoc[healthcheck.properties]
***** xref:distributed/configure/mailetcontainer.adoc[mailetcontainer.xml]
***** xref:distributed/configure/mailets.adoc[Packaged Mailets]
***** xref:distributed/configure/matchers.adoc[Packaged Matchers]
***** xref:distributed/configure/mailrepositorystore.adoc[mailrepositorystore.xml]
***** xref:distributed/configure/recipientrewritetable.adoc[recipientrewritetable.xml]
***** xref:distributed/configure/usersrepository.adoc[usersrepository.xml]
**** Extensions
***** xref:distributed/configure/vault.adoc[deletedMessageVault.properties]
***** xref:distributed/configure/extensions.adoc[extensions.properties]
***** xref:distributed/configure/listeners.adoc[listeners.xml]
***** xref:distributed/configure/spam.adoc[Anti-Spam setup]
***** xref:distributed/configure/remote-delivery-error-handling.adoc[About RemoteDelivery error handling]
***** xref:distributed/configure/collecting-contacts.adoc[Contact collection]
***** xref:distributed/configure/collecting-events.adoc[Event collection]
***** xref:distributed/configure/dsn.adoc[ESMTP DSN support]
*** xref:distributed/operate/index.adoc[Operate]
**** xref:distributed/operate/guide.adoc[]
**** xref:distributed/operate/logging.adoc[]
**** xref:distributed/operate/webadmin.adoc[]
**** xref:distributed/operate/metrics.adoc[]
**** xref:distributed/operate/migrating.adoc[]
**** xref:distributed/operate/cli.adoc[]
**** xref:distributed/operate/cassandra-migration.adoc[]
*** xref:distributed/extending/index.adoc[]
**** xref:distributed/extending/mail-processing.adoc[]
**** xref:distributed/extending/mailbox-listeners.adoc[]
**** xref:distributed/extending/smtp-hooks.adoc[]
**** xref:distributed/extending/webadmin-routes.adoc[]
** xref:test.adoc[]

This file was deleted.

@@ -71,7 +71,7 @@ any email needs you may have.
[#distributed]
== James Distributed Mail Server

The xref:distributed.adoc[*Distributed Server*] is a heavy-duty industrial
The xref:james-distributed-app:ROOT:index.adoc[*Distributed Server*] is a heavy-duty industrial
enterprise mail server.

This is the most feature-rich server, but also by far the most complex,
@@ -0,0 +1,61 @@
# Building and serving documentation locally

## Executing within source code

(Clone `https://github.com/apache/james-project` locally, go into `server/apps/distributed-app/docs` folder)

**Step 1**: [Install Antora](https://docs.antora.org/antora/2.3/install/install-antora/)

**Step 2**: Build the Antora content locally

```
antora antora-playbook-local.yml
```

**Step 3**: Open `build/site/index.html` in your browser.

## Building from the ZIP package

[Install Antora](https://docs.antora.org/antora/2.3/install/install-antora/).

Unzip `james-server-distributed-app.zip`.

Go in the `docs` folder.

Executing Antora can only be done from within a git repository.

You will need to initialize the git repository:

```
$ git init
$ git add .
$ git commit -m "First commit"
```

Then adapt `antora-playbook-local.yml` to match the git location:

```
site:
title: Apache James Distributed Server
url: https://james.apache.org/
start_page: james-distributed-app::index.adoc
content:
sources:
- url: ./
branches: HEAD
start_path: ./
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
supplemental_files: ./ui-overrides
runtime:
fetch: true
```

Build the Antora content locally

```
antora antora-playbook-local.yml
```

Open `build/site/index.html` in your browser.
@@ -0,0 +1,31 @@
#
# Use this configuration for local testing / docs develop.
#
# Note: Executing Antora can only be done from within a git repository.
# When UNZIPPING the application, you will need to initialize the git repository:
#
# $ git init
# $ git add .
# $ git commit -m "First commit"
#
# You may want to update paths below too...
site:
title: Apache James Distributed Server
url: https://james.apache.org/
start_page: james-distributed-app::index.adoc
content:
sources:
# url should match the relative position for your git repository. A value for a git repo located in the docs folder would be:
# - url: ./
- url: ./../../../../
branches: HEAD
# Must match the relative position of the Antora docs files within the git repository stated above.
# A value for a git repo located in the docs folder would be:
# start_path: ./
start_path: server/apps/distributed-app/docs
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
supplemental_files: ./ui-overrides
runtime:
fetch: true
@@ -0,0 +1,6 @@
name: james-distributed-app
title: Apache James Distributed Server
version: '3.7.0'
prerelease: SNAPSHOT
nav:
- modules/ROOT/nav.adoc