Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nd1012 committed Apr 6, 2024
1 parent 3971d8d commit 70556ca
Showing 1 changed file with 43 additions and 27 deletions.
70 changes: 43 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ for each published release on GitHub as ZIP download for self-hosting.

## Usage

### Pre-requirements

This app is a .NET 8 app and needs the ASP.NET runtime environment.

### How to get it

For example on a Debian Linux server:

```bash
mkdir /home/autodiscover
cd /home/autodiscover
wget https://github.com/nd1012/wan24-AutoDiscover/releases/download/v1.0.0/wan24-AutoDiscover.v1.0.0.zip
unzip wan24-AutoDiscover.v1.0.0.zip
rm wan24-AutoDiscover.v1.0.0.zip
```

### `appsettings.json`

The `appsettings.json` file contains the webservice configuration. The
Expand Down Expand Up @@ -93,6 +109,18 @@ Documentation references:
- [`DomainConfig`](https://nd1012.github.io/wan24-AutoDiscover/api/wan24.AutoDiscover.Models.DomainConfig.html)
- [`Protocol`](https://nd1012.github.io/wan24-AutoDiscover/api/wan24.AutoDiscover.Models.Protocol.html)

### Run as systemd service

On a Debian Linux host you can run the `wan24-AutoDiscover` microservice using
systemd:

```bash
dotnet wan24AutoDiscover.dll autodiscover systemd > /etc/systemd/system/autodiscover.service
systemctl enable autodiscover
systemctl start autodiscover
systemctl status autodiscover
```

### Apache2 proxy setup

Create the file `/etc/apache2/sites-available/autodiscover.conf`:
Expand Down Expand Up @@ -120,33 +148,6 @@ a2ensite autodiscover
systemctl restart apache2
```

### Run as systemd service

On a Debian Linux host you can run the `wan24-AutoDiscover` microservice using
systemd:

```bash
dotnet wan24AutoDiscover.dll autodiscover systemd > /etc/systemd/system/autodiscover.service
systemctl enable autodiscover
systemctl start autodiscover
systemctl status autodiscover
```

### Required DNS configuration

In order to make autodiscover working in an email client, you'll need to
create a SRV record for your email domain - example:

```txt
_autodiscover._tcp 1D IN SRV 0 0 443 [MTA-DOMAIN].
```

The domain `wan24.de` uses this record, for example:

```txt
_autodiscover._tcp 1D IN SRV 0 0 443 mail.wan24.de.
```

### POX request and response

This is an example POX request to `/autodiscover/autodiscover.xml`:
Expand Down Expand Up @@ -191,6 +192,21 @@ The response with the demo `appsettings.json`:
</Autodiscover>
```

### Required DNS configuration

In order to make autodiscover working in an email client, you'll need to
create a SRV record for your email domain - example:

```txt
_autodiscover._tcp 1D IN SRV 0 0 443 [MTA-DOMAIN].
```

The domain `wan24.de` uses this record, for example:

```txt
_autodiscover._tcp 1D IN SRV 0 0 443 mail.wan24.de.
```

### CLI API

The `wan24-AutoDiscover` has a small built in CLI API, which can do some
Expand Down

0 comments on commit 70556ca

Please sign in to comment.