docs: Update metadata and links to new locations

Also removed the FAQ inline heading link for Rancher. It's not a relevant link (as the question already expects knowledge of Rancher), and breaks out of the bg colour heading style due to the HTML generation logic from mkdocs.
This commit is contained in:
wernerfred 2021-03-11 20:41:24 +01:00 committed by polarathene
parent 237a932f8e
commit 724fe72d20
12 changed files with 27 additions and 23 deletions

View file

@ -1,5 +1,5 @@
---
title: 'LDAP Authentication'
title: 'Advanced | LDAP Authentication'
---
## Introduction

View file

@ -1,5 +1,5 @@
---
title: 'Full-Text Search'
title: 'Advanced | Full-Text Search'
---
## Overview

View file

@ -1,5 +1,5 @@
---
title: 'IPv6'
title: 'Advanced | IPv6'
---
## Background

View file

@ -1,5 +1,5 @@
---
title: 'Kubernetes'
title: 'Advanced | Kubernetes'
---
## Deployment Example

View file

@ -1,5 +1,5 @@
---
title: 'Email Gathering with Fetchmail'
title: 'Advanced | Email Gathering with Fetchmail'
---
To enable the [fetchmail][fetchmail-website] service to retrieve e-mails set the environment variable `ENABLE_FETCHMAIL` to `1`. Your `docker-compose.yml` file should look like following snippet:
@ -114,7 +114,7 @@ fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 2
fetchmail: normal termination, status 1
```
[docs-setup]: ../config/setup.sh.md
[docs-setup]: ../../config/setup.sh.md
[fetchmail-website]: https://www.fetchmail.info
[fetchmail-docs]: https://www.fetchmail.info/fetchmail-man.html
[fetchmail-docs-run]: https://www.fetchmail.info/fetchmail-man.html#31

View file

@ -1,5 +1,5 @@
---
title: 'Email Filtering with Sieve'
title: 'Advanced | Email Filtering with Sieve'
---
## User-Defined Sieve Filters

View file

@ -1,5 +1,5 @@
---
title: 'Optional Configuration'
title: 'Advanced | Optional Configuration'
hide:
- toc # Hide Table of Contents for this page
---
@ -39,16 +39,16 @@ This is a list of all configuration files and directories which are optional or
- **dovecot.cf:** replaces `/etc/dovecot/local.conf`. (Docs: [Override Dovecot Defaults][docs-override-dovecot])
- **dovecot-quotas.cf:** list of custom quotas per mailbox. (Docs: [Accounts][docs-accounts-quota])
[docs-accounts-quota]: ../config/user-management/accounts.md#notes
[docs-aliases-regex]: ../config/user-management/aliases.md#configuring-regexp-aliases
[docs-dkim]: ../config/best-practices/dkim.md
[docs-fail2ban]: ../config/security/fail2ban.md
[docs-faq-spamrules]: ../config/troubleshooting/faq.md#how-can-i-manage-my-custom-spamassassin-rules
[docs-accounts-quota]: ../../config/user-management/accounts.md#notes
[docs-aliases-regex]: ../../config/user-management/aliases.md#configuring-regexp-aliases
[docs-dkim]: ../../config/best-practices/dkim.md
[docs-fail2ban]: ../../config/security/fail2ban.md
[docs-faq-spamrules]: ../../faq.md#how-can-i-manage-my-custom-spamassassin-rules
[docs-override-postfix]: ./override-defaults/postfix.md
[docs-override-dovecot]: ./override-defaults/dovecot.md
[docs-relayhosts-senderauth]: ./mail-forwarding/relay-hosts.md#sender-dependent-authentication
[docs-relayhosts-senderhost]: ./mail-forwarding/relay-hosts.md#sender-dependent-relay-host
[docs-sieve]: ./mail-sieve.md
[docs-setupsh]: ../config/setup.sh.md
[docs-ssl]: ../config/security/ssl.md
[docs-setupsh]: ../../config/setup.sh.md
[docs-ssl]: ../../config/security/ssl.md
[github-commit-setup-stack.sh-L411]: https://github.com/docker-mailserver/docker-mailserver/blob/941e7acdaebe271eaf3d296b36d4d81df4c54b90/target/scripts/startup/setup-stack.sh#L411

View file

@ -1,5 +1,5 @@
---
title: 'Tutorials | Installation Examples'
title: 'Tutorials | Basic Installation'
---
## Building a Simple Mailserver

View file

@ -1,3 +1,7 @@
---
title: 'Tutorials | Mailserver behind Proxy'
---
## Using `docker-mailserver` behind a Proxy
### Information
@ -120,4 +124,4 @@ service imap-login {
!!! note
Port `10993` is used here to avoid conflicts with internal systems like `postscreen` and `amavis` as they will exchange messages on the default port and obviously have a different origin then compared to the proxy.
[docs-optionalconfig]: ../advanced/optional-config.md
[docs-optionalconfig]: ../../config/advanced/optional-config.md

View file

@ -1,5 +1,5 @@
---
title: 'Troubleshooting | FAQ'
title: 'FAQ'
---
### What kind of database are you using?
@ -307,7 +307,7 @@ Otherwise, it could work with 512M of RAM.
Current figure is about 850M and growing. If you get errors about clamav or amavis failing to allocate memory you need more RAM or more swap and of course docker must be allowed to use swap (not always the case). If you can't use swap at all you may need 3G RAM.
### Can `docker-mailserver` run in a [Rancher Environment](http://rancher.com/rancher/)?
### Can `docker-mailserver` run in a Rancher Environment?
Yes, by adding the environment variable `PERMIT_DOCKER: network`.
@ -401,7 +401,7 @@ sed -i 's/rimap -r/rimap/' /etc/supervisor/conf.d/saslauth.conf
supervisorctl update
```
[docs-maintenance]: ../../advanced/maintenance/update-and-cleanup.md
[docs-maintenance]: ./config/advanced/maintenance/update-and-cleanup.md
[github-issue-95]: https://github.com/docker-mailserver/docker-mailserver/issues/95
[github-issue-97]: https://github.com/docker-mailserver/docker-mailserver/issues/97
[github-issue-1247]: https://github.com/docker-mailserver/docker-mailserver/issues/1247

View file

@ -23,8 +23,8 @@ This wiki provides you with advanced configuration, detailed examples, and hints
We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the [Contributing section][docs-contributing].
[docs-contributing]: ./contributing/issues-and-pull-requests.md
[docs-faq]: ./config/troubleshooting/faq.md
[docs-optionalconfig]: ./advanced/optional-config.md
[docs-faq]: ./faq.md
[docs-optionalconfig]: ./config/advanced/optional-config.md
[docs-setupsh]: ./config/setup.sh.md
[github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md

View file

@ -101,7 +101,7 @@ nav:
- 'Mailserver behind Proxy': examples/tutorials/mailserver-behind-proxy.md
- 'Use Cases':
- 'Forward-Only Mailserver with LDAP': examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md
- 'FAQ' : faq/faq.md
- 'FAQ' : faq.md
- 'Contributing':
- 'Issues and Pull Requests': contributing/issues-and-pull-requests.md
- 'Coding Style': contributing/coding-style.md