mirror of
https://github.com/nodemailer/wildduck.git
synced 2024-09-20 07:16:05 +08:00
Add wildduck-dockerized as an install option (#312)
This commit is contained in:
parent
0595d61c10
commit
a5d8478095
|
@ -8,6 +8,7 @@
|
|||
- [API Documentation :link:](//docs.wildduck.email/api)
|
||||
- [Error codes](api-error-codes.md)
|
||||
- Additional software
|
||||
- [WildDuck: dockerized](additional-software/wildduck-dockerized.md)
|
||||
- [WildDuck MTA (Outbound SMTP)](additional-software/wildduck-mta.md)
|
||||
- [Haraka plugin (Inbound SMTP)](additional-software/haraka-plugin.md)
|
||||
- [Rspamd (Spam detection)](additional-software/rspamd.md)
|
||||
|
@ -22,5 +23,5 @@
|
|||
- [Administrating WildDuck via command line](in-depth/command-line.md)
|
||||
- [Attachment deduplication](in-depth/attachment-deduplication.md)
|
||||
- [Retention policies](in-depth/retention-policies.md)
|
||||
- [Docker](in-depth/docker.md)
|
||||
- [Wildduck docker image](in-depth/docker.md)
|
||||
- [API roles](in-depth/roles.md)
|
||||
|
|
|
@ -1,7 +1,10 @@
|
|||
# Usage
|
||||
# Installing WildDuck
|
||||
|
||||
## Scripted install
|
||||
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)
|
||||
|
@ -10,22 +13,27 @@ Install script installs and configures all required dependencies and services, i
|
|||
|
||||
Tested on a 10\$ DigitalOcean Ubuntu 16.04 instance.
|
||||
|
||||
![](https://cldup.com/TZoTfxPugm.png)
|
||||
|
||||
- Web interface at https://wildduck.email that uses WildDuck API
|
||||
### 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.
|
||||
|
||||
## Manual install
|
||||
[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
|
||||
#### Step 1\. Get the code from github
|
||||
|
||||
```
|
||||
$ git clone git://github.com/nodemailer/wildduck.git
|
||||
$ cd wildduck
|
||||
```
|
||||
|
||||
### Step 2\. Install dependencies
|
||||
#### Step 2\. Install dependencies
|
||||
|
||||
Install dependencies from npm
|
||||
|
||||
|
@ -33,7 +41,7 @@ Install dependencies from npm
|
|||
$ npm install --production
|
||||
```
|
||||
|
||||
### Step 3\. Run the server
|
||||
#### Step 3\. Run the server
|
||||
|
||||
To use the [default config](https://github.com/nodemailer/wildduck/blob/master/config/default.toml) file, run the following:
|
||||
|
||||
|
@ -50,15 +58,15 @@ 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
|
||||
#### 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
|
||||
#### 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
|
||||
### 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).
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Docker
|
||||
# Wildduck docker image
|
||||
|
||||
## Obtaining the Docker image
|
||||
To pull the latest pre-built image of wildduck from docker hub:
|
||||
|
|
Loading…
Reference in a new issue