mirror of
https://github.com/nodemailer/wildduck.git
synced 2025-01-08 00:48:52 +08:00
90 lines
No EOL
3.2 KiB
Markdown
90 lines
No EOL
3.2 KiB
Markdown
# Installing WildDuck
|
|
|
|
WildDuck itself is only an IMAP and POP3 server, with simple LMTP support if needed. However, because of its integration with ZoneMTA and Haraka, it can function as a complete mail server. Below are instructions for installing a complete mail server, or only WildDuck itself.
|
|
|
|
## Complete mail server
|
|
|
|
### Scripted install
|
|
If you have a blank VPS and a free domain name that you can point to that VPS than you can try out the scripted all-included install
|
|
|
|
[Installation instructions](https://github.com/nodemailer/wildduck/tree/master/setup)
|
|
|
|
Install script installs and configures all required dependencies and services, including Let's Encrypt based certs, to run WildDuck as a mail server.
|
|
|
|
Tested on a 10\$ DigitalOcean Ubuntu 16.04 instance.
|
|
|
|
|
|
### Docker
|
|
This method can be used on both new or existing servers, no matter the distro. If it supports docker, it will work (amd64 only right now, arm support will be added at a later time). Docker also makes updating or uninstalling all components quite easy.
|
|
|
|
[Installation instructions](https://github.com/nodemailer/wildduck-dockerized)
|
|
|
|
The `docker-compose.yml` together with the default configuration script will set up all required dependencies and services, including Let's Encrypt based certs, to run WildDuck as a mail server.
|
|
|
|
## WildDuck only
|
|
### Manual install
|
|
|
|
Assuming you have MongoDB and Redis running somewhere.
|
|
|
|
#### Step 1\. Get the code from github
|
|
|
|
```
|
|
$ git clone git://github.com/nodemailer/wildduck.git
|
|
$ cd wildduck
|
|
```
|
|
|
|
#### Step 2\. Install dependencies
|
|
|
|
Install dependencies from npm
|
|
|
|
```
|
|
$ npm install --production
|
|
```
|
|
|
|
#### Step 3\. Run the server
|
|
|
|
To use the [default config](https://github.com/nodemailer/wildduck/blob/master/config/default.toml) file, run the following:
|
|
|
|
```
|
|
node server.js
|
|
```
|
|
|
|
Or if you want to override default configuration options with your own, run the following (custom config file is merged with the default, so specify only these
|
|
values that you want to change):
|
|
|
|
```
|
|
node server.js --config=/etc/wildduck.toml
|
|
```
|
|
|
|
> For additional config options, see the _wild-config_ [documentation](https://github.com/nodemailer/wild-config).
|
|
|
|
#### Step 4\. Create a user account
|
|
|
|
See [API Docs](https://docs.wildduck.email/api/#api-Users-PostUser) for details about creating new user accounts
|
|
|
|
#### Step 5\. Use an IMAP/POP3 client to log in
|
|
|
|
Any IMAP or POP3 client will do. Use the credentials from step 4\. to log in.
|
|
|
|
### Docker Install
|
|
The easiest way to setup wildduck with a docker image is given below, for more documentation about configuration options in the docker image, refer to
|
|
the [in-depth page on the Docker](in-depth/docker.md).
|
|
|
|
|
|
A docker hub image built using the [Dockerfile](https://github.com/nodemailer/wildduck/blob/master/Dockerfile) in the repo is also available
|
|
|
|
To pull the latest pre-built image of wildduck:
|
|
|
|
```
|
|
docker pull nodemailer/wildduck
|
|
```
|
|
|
|
It is also possible to pull a specific version of wildduck by specifying the version as the image tag.
|
|
(example, for version 1.20):
|
|
```
|
|
docker pull nodemailer/wildduck:1.20
|
|
```
|
|
To run the docker image using the [default config](https://github.com/nodemailer/wildduck/blob/master/config/default.toml), and `mongodb` and `redis` from the host machine, use:
|
|
```
|
|
docker run --network=host nodemailer/wildduck
|
|
``` |