Skip to content

Commit

Permalink
fix(readme): Updated readme to trigger package publish
Browse files Browse the repository at this point in the history
  • Loading branch information
andris9 committed Sep 18, 2023
1 parent 4f75285 commit b90d31b
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ZoneMTA (internal code name X-699)

Modern outbound SMTP relay (MTA/MSA) built on Node.js and MongoDB (queue storage). It's kind of like Postfix for outbound but is able to use multiple local IP addresses and is easily extendable using plugins.
Outbound SMTP relay (MTA/MSA) built on Node.js and MongoDB (queue storage).

```
███████╗ ██████╗ ███╗ ██╗███████╗███╗ ███╗████████╗ █████╗
Expand All @@ -17,21 +17,15 @@ ZoneMTA is comparable to [Haraka](https://haraka.github.io/) but unlike Haraka i

There's also a web-based [administration interface](https://github.com/zone-eu/zmta-webadmin) (needs to be installed separately).

## Upgrade notes

ZoneMTA version 1.1 uses a different application configuration scheme than 1.0. See [zone-mta-template](https://github.com/zone-eu/zone-mta-template) for reference.

Also, there is no zone-mta command line application anymore, you need to include it as a module.

## Requirements

1. **Node.js** v8.0.0+ for running the app
1. **Node.js** v16+ for running the app
2. **MongoDB** for storing messages in the queue
3. **Redis** for locking and counters

## Quickstart

Assuming [Node.js](https://nodejs.org/en/download/package-manager/) (v8.0.0+), _MongoDB_ running on localhost and _git_. There must be nothing listening on ports 2525 (SMTP), 12080 (HTTP API) and 12081 (internal data channel). All these ports are configurable.
Assuming [Node.js](https://nodejs.org/en/download/package-manager/) (v16+), _MongoDB_ running on localhost and _git_. There must be nothing listening on ports 2525 (SMTP), 12080 (HTTP API) and 12081 (internal data channel). All these ports are configurable.

#### Create ZoneMTA application

Expand Down Expand Up @@ -216,6 +210,7 @@ in `default.js` file:
```

or in `pools.toml` file:

```
[[ipWarmPool]]
address="1.2.3.1"
Expand All @@ -231,7 +226,6 @@ name="warmup.example.com"
ratio="0.05"
```


Once your IP address is warm enough then you can either increase the load ratio for it or remove the parameter entirely to share load evenly between all addresses. Be aware though that every time you change pool structure it mixes up the address resolving, so a message that is currently deferred for greylisting does not get the same IP address that it previously used and thus might get greylisted again.

### Delivery to HTTP
Expand Down

0 comments on commit b90d31b

Please sign in to comment.