Skip to content

Commit 463bc96

Browse files
wernerfredpolarathene
authored andcommitted
docs(fix): Update wiki references to the new docs url
Additionally replaces old references to `tvial` images with the new `mailserver` docker image name.
1 parent 724fe72 commit 463bc96

17 files changed

+37
-37
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ Possible answers to your issue
1313
https://github.com/docker-mailserver/docker-mailserver#requirements
1414
1515
* Email seen as spam:
16-
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SPF
17-
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-DKIM
16+
https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/spf
17+
https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim
1818
1919
* Creating new domains and accounts
20-
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Accounts
20+
https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts
2121
2222
* Use a relay mail server
23-
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-AWS-SES
23+
https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-forwarding/aws-ses
2424
The variable name can be used for other email servers.
2525
2626
* FAQ and tips
27-
https://github.com/docker-mailserver/docker-mailserver/wiki/FAQ-and-Tips
27+
https://docker-mailserver.github.io/docker-mailserver/edge/faq
2828
29-
* The wiki
30-
https://github.com/docker-mailserver/docker-mailserver/wiki
29+
* The documentation
30+
https://docker-mailserver.github.io/docker-mailserver/edge
3131
3232
* Open issues
3333
https://github.com/docker-mailserver/docker-mailserver/issues

.github/ISSUE_TEMPLATE/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
blank_issues_enabled: false
33

44
contact_links:
5-
- name: Wiki
6-
url: https://github.com/docker-mailserver/docker-mailserver/wiki
5+
- name: Documentation
6+
url: https://docker-mailserver.github.io/docker-mailserver/edge
77
about: Extended documentaton - visit this first before opening issues
88
- name: Default Documentation
99
url: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ Fixes # (issue)
2020
- [ ] My code follows the style guidelines of this project
2121
- [ ] I have performed a self-review of my own code
2222
- [ ] I have commented my code, particularly in hard-to-understand areas
23-
- [ ] I have made corresponding changes to the documentation (README.md or ENVIRONMENT.md or the Wiki)
23+
- [ ] I have made corresponding changes to the documentation (README.md or ENVIRONMENT.md or the documentation)
2424
- [ ] If necessary I have added tests that prove my fix is effective or that my feature works
2525
- [ ] New and existing unit tests pass locally with my changes

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Examples of unacceptable behavior include:
2929

3030
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
3131

32-
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, documentation edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
3333

3434
## Scope
3535

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
This project is Open Source. That means that you can contribute on enhancements, bug fixing or improving the documentation in the [Wiki](https://github.com/docker-mailserver/docker-mailserver/wiki).
3+
This project is Open Source. That means that you can contribute on enhancements, bug fixing or improving the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge).
44

55
1. [Issues & PRs](#issues--prs)
66
1. [Opening an Issue](#opening-an-issue)
@@ -13,7 +13,7 @@ This project is Open Source. That means that you can contribute on enhancements,
1313

1414
### Opening an Issue
1515

16-
**Before opening an issue**, read the [`README`](./README.md) carefully, use the [Wiki](https://github.com/docker-mailserver/docker-mailserver/wiki/), the Postfix/Dovecot documentation and your search engine you trust. The issue tracker is not meant to be used for unrelated questions! When opening an issue, please provide details use case to let the community reproduce your problem. Please start the mail server with env `DMS_DEBUG=1` and paste the output into the issue. **Use the issue templates** to provide the necessary information. Issues which do not use these templates are not worked on and closed. By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.
16+
**Before opening an issue**, read the [`README`](./README.md) carefully, use the [Documentation](https://docker-mailserver.github.io/docker-mailserver/edge), the Postfix/Dovecot documentation and your search engine you trust. The issue tracker is not meant to be used for unrelated questions! When opening an issue, please provide details use case to let the community reproduce your problem. Please start the mail server with env `DMS_DEBUG=1` and paste the output into the issue. **Use the issue templates** to provide the necessary information. Issues which do not use these templates are not worked on and closed. By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.
1717

1818
Maintainers take the time to improve on this project and help by solving issues together. It is therefore expected from others to make an effort and **comply with the rules**.
1919

ENVIRONMENT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Otherwise, `iptables` won't be able to ban IPs.
7171
- Optional: `SSL_ALT_CERT_PATH` and `SSL_ALT_KEY_PATH` allow providing a 2nd certificate as a fallback for dual (aka hybrid) certificate support. Useful for ECDSA with an RSA fallback. Presently only `manual` mode supports this feature.
7272
- self-signed => Enables self-signed certificates.
7373

74-
Please read [the SSL page in the wiki](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SSL) for more information.
74+
Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl) for more information.
7575

7676
##### TLS_LEVEL
7777

@@ -144,7 +144,7 @@ Set the mailbox size limit for all users. If set to zero, the size will be unlim
144144
- **1** => Dovecot quota is enabled
145145
- 0 => Dovecot quota is disabled
146146

147-
See [mailbox quota](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Accounts#mailbox-quota).
147+
See [mailbox quota](https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts/#notes).
148148

149149
##### POSTFIX\_MESSAGE\_SIZE\_LIMIT
150150

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.)
2222
## Included Services
2323

2424
- [Postfix](http://www.postfix.org) with SMTP or LDAP auth
25-
- [Dovecot](https://www.dovecot.org) for SASL, IMAP (or POP3), with LDAP Auth, Sieve and [quotas](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Accounts#mailbox-quota)
25+
- [Dovecot](https://www.dovecot.org) for SASL, IMAP (or POP3), with LDAP Auth, Sieve and [quotas](https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts#notes)
2626
- [Amavis](https://www.amavis.org/)
2727
- [Spamassasin](http://spamassassin.apache.org/) supporting custom rules
2828
- [ClamAV](https://www.clamav.net/) with automatic updates
@@ -33,8 +33,8 @@ A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.)
3333
- [Postscreen](http://www.postfix.org/POSTSCREEN_README.html)
3434
- [Postgrey](https://postgrey.schweikert.ch/)
3535
- [LetsEncrypt](https://letsencrypt.org/) and self-signed certificates
36-
- [Setup script](https://github.com/docker-mailserver/docker-mailserver/wiki/setup.sh) to easily configure and maintain your mailserver
37-
- Basic [Sieve support](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Sieve-filters) using dovecot
36+
- [Setup script](https://docker-mailserver.github.io/docker-mailserver/edge/config/setup.sh) to easily configure and maintain your mailserver
37+
- Basic [Sieve support](https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-sieve) using dovecot
3838
- SASLauthd with LDAP auth
3939
- Persistent data and state
4040
- [CI/CD](https://github.com/docker-mailserver/docker-mailserver/actions)
@@ -53,7 +53,7 @@ A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.)
5353
- 1 vCore
5454
- 512MB RAM
5555

56-
**Note:** You'll need to deactivate some services like ClamAV to be able to run on a host with 512MB of RAM. Even with 1G RAM you may run into problems without swap, see [FAQ](https://github.com/docker-mailserver/docker-mailserver/wiki/FAQ-and-Tips).
56+
**Note:** You'll need to deactivate some services like ClamAV to be able to run on a host with 512MB of RAM. Even with 1G RAM you may run into problems without swap, see [FAQ](https://docker-mailserver.github.io/docker-mailserver/edge/faq/#what-system-requirements-are-required-to-run-docker-mailserver-effectively).
5757

5858
## Usage
5959

@@ -108,7 +108,7 @@ chmod a+x ./setup.sh
108108
- don't quote your values
109109
- variable substitution is *not* supported (e.g. `OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME`).
110110
- Variables in `.env` are expanded in the `docker-compose.yml` file **only** and **not** in the container. The file `mailserver.env` serves this case where environment variables are used in the container.
111-
- If you want to use a bare domain (host name = domain name), see [FAQ](https://github.com/docker-mailserver/docker-mailserver/wiki/FAQ-and-Tips#can-i-use-nakedbare-domains-no-host-name)
111+
- If you want to use a bare domain (host name = domain name), see [FAQ](https://docker-mailserver.github.io/docker-mailserver/edge/faq#can-i-use-nakedbare-domains-no-host-name)
112112

113113
### Get up and running
114114

@@ -223,7 +223,7 @@ If you got any problems with SPF and/or forwarding mails, give [SRS](https://git
223223
2. Receives email and filters for spam and viruses. For submitting outgoing mail you should prefer the submission ports(465, 587), which require authentication. Unless a relay host is configured, outgoing email will leave the server via port 25(thus outbound traffic must not be blocked by your provider or firewall).
224224
3. A submission port since 2018, [RFC 8314](https://tools.ietf.org/html/rfc8314). Originally a secure variant of port 25.
225225

226-
See the [wiki](https://github.com/docker-mailserver/docker-mailserver/wiki) for further details and best practice advice, especially regarding security concerns.
226+
See the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/understanding-the-ports/) for further details and best practice advice, especially regarding security concerns.
227227

228228
## Examples
229229

docs/content/config/advanced/auth-ldap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ version: '2'
3939

4040
services:
4141
mail:
42-
image: tvial/docker-mailserver:latest
42+
image: mailserver/docker-mailserver:latest
4343
hostname: mail
4444
domainname: domain.com
4545
container_name: mail

docs/content/config/advanced/full-text-search.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The [dovecot-solr Plugin](https://wiki2.dovecot.org/Plugins/FTS/Solr) is used in
2020
restart: always
2121

2222
mailserver:
23-
image: tvial/docker-mailserver:latest
23+
image: mailserver/docker-mailserver:latest
2424
...
2525
volumes:
2626
...

docs/content/config/advanced/kubernetes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ spec:
144144
# mountPath: /tmp/files
145145
containers:
146146
- name: docker-mailserver
147-
image: tvial/docker-mailserver:latest
147+
image: mailserver/docker-mailserver:latest
148148
imagePullPolicy: Always
149149
volumeMounts:
150150
- name: config

docs/content/config/security/ssl.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ The second part of the setup is the actual mail container. So, in another folder
190190
version: '2'
191191
services:
192192
mail:
193-
image: tvial/docker-mailserver:latest
193+
image: mailserver/docker-mailserver:latest
194194
hostname: ${HOSTNAME}
195195
domainname: ${DOMAINNAME}
196196
container_name: ${CONTAINER_NAME}
@@ -379,7 +379,7 @@ This allows for support of wild card certificates: `SSL_DOMAIN=*.example.com`. H
379379
version: '3.8'
380380
services:
381381
mail:
382-
image: tvial/docker-mailserver:stable
382+
image: mailserver/docker-mailserver:stable
383383
hostname: mail
384384
domainname: example.com
385385
volumes:
@@ -427,7 +427,7 @@ Depending of your Traefik configuration, certificates may be stored using a file
427427
You can easily generate a self-signed SSL certificate by using the following command:
428428

429429
```sh
430-
docker run -it --rm -v "$(pwd)"/config/ssl:/tmp/docker-mailserver/ssl -h mail.my-domain.com -t tvial/docker-mailserver generate-ssl-certificate
430+
docker run -it --rm -v "$(pwd)"/config/ssl:/tmp/docker-mailserver/ssl -h mail.my-domain.com -t mailserver/docker-mailserver generate-ssl-certificate
431431

432432
# Press enter
433433
# Enter a password when needed

docs/content/contributing/issues-and-pull-requests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This project is Open Source. That means that you can contribute on enhancements,
88

99
!!! attention
1010

11-
**Before opening an issue**, read the [`README`][github-file-readme] carefully, use the [Wiki][wiki], the Postfix/Dovecot documentation and your search engine you trust. The issue tracker is not meant to be used for unrelated questions!
11+
**Before opening an issue**, read the [`README`][github-file-readme] carefully, study the [documentation][docs], the Postfix/Dovecot documentation and your search engine you trust. The issue tracker is not meant to be used for unrelated questions!
1212

1313
When opening an issue, please provide details use case to let the community reproduce your problem. Please start the mail server with env `DMS_DEBUG=1` and paste the output into the issue.
1414

@@ -43,7 +43,7 @@ The development workflow is the following:
4343
2. When your changes are validated, your branch is merged
4444
3. CI builds the new `:edge` image immediately and your changes will be includes in the next version release.
4545

46-
[wiki]: https://docker-mailserver.github.io/docker-mailserver
46+
[docs]: https://docker-mailserver.github.io/docker-mailserver/edge
4747
[github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
4848
[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
4949
[commit]: https://help.github.com/articles/closing-issues-via-commit-messages/

docs/content/examples/tutorials/basic-installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ We are going to use this docker based mailserver:
2727
2828
services:
2929
mail:
30-
image: tvial/docker-mailserver:latest
30+
image: mailserver/docker-mailserver:latest
3131
hostname: mail
3232
domainname: example.org
3333
container_name: mail
@@ -76,7 +76,7 @@ We are going to use this docker based mailserver:
7676

7777
On your server you may have to do it differently.
7878

79-
- Pull the docker image: `docker pull tvial/docker-mailserver:latest`
79+
- Pull the docker image: `docker pull mailserver/docker-mailserver:latest`
8080

8181
- Now generate the DKIM keys with `./setup.sh config dkim` and copy the content of the file `config/opendkim/keys/domain.tld/mail.txt` on the domain zone configuration at the DNS server. I use [bind9](https://github.com/docker-scripts/bind9) for managing my domains, so I just paste it on `example.org.db`:
8282

docs/content/examples/tutorials/mailserver-behind-proxy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Feel free to add your configuration if you achived the same goal using different
6060
version: '2'
6161
services:
6262
mail:
63-
image: tvial/docker-mailserver:release-v7.2.0
63+
image: mailserver/docker-mailserver:release-v7.2.0
6464
restart: always
6565
networks:
6666
- proxy

docs/content/faq.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Then with plain `docker-compose`:
187187
```yaml
188188
services:
189189
mail:
190-
image: tvial/docker-mailserver:latest
190+
image: mailserver/docker-mailserver:latest
191191
volumes:
192192
- ./cron/sa-learn:/etc/cron.d/sa-learn
193193
```
@@ -199,7 +199,7 @@ version: "3.3"
199199

200200
services:
201201
mail:
202-
image: tvial/docker-mailserver:latest
202+
image: mailserver/docker-mailserver:latest
203203
# ...
204204
configs:
205205
- source: my_sa_crontab
@@ -351,7 +351,7 @@ proxy_interfaces = X.X.X.X (your public IP)
351351
### What About Updates
352352

353353
You can of course use a own script or every now and then pull && stop && rm && start the images but there are tools available for this.
354-
There is a page in the [Update and Cleanup][docs-maintenance] wiki page that explains how to use it the docker way.
354+
There is a section in the [Update and Cleanup][docs-maintenance] documentation page that explains how to use it the docker way.
355355

356356
### How to adjust settings with the `user-patches.sh` script
357357

docs/content/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Home
66

77
Please first have a look at the [`README.md`][github-file-readme] to setup and configure this server.
88

9-
This wiki provides you with advanced configuration, detailed examples, and hints.
9+
This documentation provides you with advanced configuration, detailed examples, and hints.
1010

1111
## Getting Started
1212

mailserver.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ POSTSCREEN_ACTION=enforce
8383
# 1 => only launch postfix smtp
8484
SMTP_ONLY=
8585

86-
# Please read [the SSL page in the wiki](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SSL) for more information.
86+
# Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl) for more information.
8787
#
8888
# empty => SSL disabled
8989
# letsencrypt => Enables Let's Encrypt certificates

0 commit comments

Comments
 (0)