docs(fix): Update wiki references to the new docs url

Additionally replaces old references to `tvial` images with the new `mailserver` docker image name.
This commit is contained in:
wernerfred 2021-03-01 21:32:45 +01:00 committed by polarathene
parent 724fe72d20
commit 463bc967d2
17 changed files with 37 additions and 37 deletions

View file

@ -13,21 +13,21 @@ Possible answers to your issue
https://github.com/docker-mailserver/docker-mailserver#requirements https://github.com/docker-mailserver/docker-mailserver#requirements
* Email seen as spam: * Email seen as spam:
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SPF https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/spf
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-DKIM https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim
* Creating new domains and accounts * Creating new domains and accounts
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Accounts https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts
* Use a relay mail server * Use a relay mail server
https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-AWS-SES https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-forwarding/aws-ses
The variable name can be used for other email servers. The variable name can be used for other email servers.
* FAQ and tips * FAQ and tips
https://github.com/docker-mailserver/docker-mailserver/wiki/FAQ-and-Tips https://docker-mailserver.github.io/docker-mailserver/edge/faq
* The wiki * The documentation
https://github.com/docker-mailserver/docker-mailserver/wiki https://docker-mailserver.github.io/docker-mailserver/edge
* Open issues * Open issues
https://github.com/docker-mailserver/docker-mailserver/issues https://github.com/docker-mailserver/docker-mailserver/issues

View file

@ -2,8 +2,8 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Wiki - name: Documentation
url: https://github.com/docker-mailserver/docker-mailserver/wiki url: https://docker-mailserver.github.io/docker-mailserver/edge
about: Extended documentaton - visit this first before opening issues about: Extended documentaton - visit this first before opening issues
- name: Default Documentation - name: Default Documentation
url: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md url: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md

View file

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

View file

@ -29,7 +29,7 @@ Examples of unacceptable behavior include:
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. 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.
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. 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.
## Scope ## Scope

View file

@ -1,6 +1,6 @@
# Contributing # Contributing
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). 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).
1. [Issues & PRs](#issues--prs) 1. [Issues & PRs](#issues--prs)
1. [Opening an Issue](#opening-an-issue) 1. [Opening an Issue](#opening-an-issue)
@ -13,7 +13,7 @@ This project is Open Source. That means that you can contribute on enhancements,
### Opening an Issue ### Opening an Issue
**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. **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.
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**. 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**.

View file

@ -71,7 +71,7 @@ Otherwise, `iptables` won't be able to ban IPs.
- 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. - 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.
- self-signed => Enables self-signed certificates. - self-signed => Enables self-signed certificates.
Please read [the SSL page in the wiki](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SSL) for more information. Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl) for more information.
##### TLS_LEVEL ##### TLS_LEVEL
@ -144,7 +144,7 @@ Set the mailbox size limit for all users. If set to zero, the size will be unlim
- **1** => Dovecot quota is enabled - **1** => Dovecot quota is enabled
- 0 => Dovecot quota is disabled - 0 => Dovecot quota is disabled
See [mailbox quota](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Accounts#mailbox-quota). See [mailbox quota](https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts/#notes).
##### POSTFIX\_MESSAGE\_SIZE\_LIMIT ##### POSTFIX\_MESSAGE\_SIZE\_LIMIT

View file

@ -22,7 +22,7 @@ A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.)
## Included Services ## Included Services
- [Postfix](http://www.postfix.org) with SMTP or LDAP auth - [Postfix](http://www.postfix.org) with SMTP or LDAP auth
- [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) - [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)
- [Amavis](https://www.amavis.org/) - [Amavis](https://www.amavis.org/)
- [Spamassasin](http://spamassassin.apache.org/) supporting custom rules - [Spamassasin](http://spamassassin.apache.org/) supporting custom rules
- [ClamAV](https://www.clamav.net/) with automatic updates - [ClamAV](https://www.clamav.net/) with automatic updates
@ -33,8 +33,8 @@ A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.)
- [Postscreen](http://www.postfix.org/POSTSCREEN_README.html) - [Postscreen](http://www.postfix.org/POSTSCREEN_README.html)
- [Postgrey](https://postgrey.schweikert.ch/) - [Postgrey](https://postgrey.schweikert.ch/)
- [LetsEncrypt](https://letsencrypt.org/) and self-signed certificates - [LetsEncrypt](https://letsencrypt.org/) and self-signed certificates
- [Setup script](https://github.com/docker-mailserver/docker-mailserver/wiki/setup.sh) to easily configure and maintain your mailserver - [Setup script](https://docker-mailserver.github.io/docker-mailserver/edge/config/setup.sh) to easily configure and maintain your mailserver
- Basic [Sieve support](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Sieve-filters) using dovecot - Basic [Sieve support](https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-sieve) using dovecot
- SASLauthd with LDAP auth - SASLauthd with LDAP auth
- Persistent data and state - Persistent data and state
- [CI/CD](https://github.com/docker-mailserver/docker-mailserver/actions) - [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.)
- 1 vCore - 1 vCore
- 512MB RAM - 512MB RAM
**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). **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).
## Usage ## Usage
@ -108,7 +108,7 @@ chmod a+x ./setup.sh
- don't quote your values - don't quote your values
- variable substitution is *not* supported (e.g. `OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME`). - variable substitution is *not* supported (e.g. `OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME`).
- 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. - 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.
- 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) - 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)
### Get up and running ### Get up and running
@ -223,7 +223,7 @@ If you got any problems with SPF and/or forwarding mails, give [SRS](https://git
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). 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).
3. A submission port since 2018, [RFC 8314](https://tools.ietf.org/html/rfc8314). Originally a secure variant of port 25. 3. A submission port since 2018, [RFC 8314](https://tools.ietf.org/html/rfc8314). Originally a secure variant of port 25.
See the [wiki](https://github.com/docker-mailserver/docker-mailserver/wiki) for further details and best practice advice, especially regarding security concerns. 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.
## Examples ## Examples

View file

@ -39,7 +39,7 @@ version: '2'
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
hostname: mail hostname: mail
domainname: domain.com domainname: domain.com
container_name: mail container_name: mail

View file

@ -20,7 +20,7 @@ The [dovecot-solr Plugin](https://wiki2.dovecot.org/Plugins/FTS/Solr) is used in
restart: always restart: always
mailserver: mailserver:
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
... ...
volumes: volumes:
... ...

View file

@ -144,7 +144,7 @@ spec:
# mountPath: /tmp/files # mountPath: /tmp/files
containers: containers:
- name: docker-mailserver - name: docker-mailserver
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
imagePullPolicy: Always imagePullPolicy: Always
volumeMounts: volumeMounts:
- name: config - name: config

View file

@ -190,7 +190,7 @@ The second part of the setup is the actual mail container. So, in another folder
version: '2' version: '2'
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
hostname: ${HOSTNAME} hostname: ${HOSTNAME}
domainname: ${DOMAINNAME} domainname: ${DOMAINNAME}
container_name: ${CONTAINER_NAME} container_name: ${CONTAINER_NAME}
@ -379,7 +379,7 @@ This allows for support of wild card certificates: `SSL_DOMAIN=*.example.com`. H
version: '3.8' version: '3.8'
services: services:
mail: mail:
image: tvial/docker-mailserver:stable image: mailserver/docker-mailserver:stable
hostname: mail hostname: mail
domainname: example.com domainname: example.com
volumes: volumes:
@ -427,7 +427,7 @@ Depending of your Traefik configuration, certificates may be stored using a file
You can easily generate a self-signed SSL certificate by using the following command: You can easily generate a self-signed SSL certificate by using the following command:
```sh ```sh
docker run -it --rm -v "$(pwd)"/config/ssl:/tmp/docker-mailserver/ssl -h mail.my-domain.com -t tvial/docker-mailserver generate-ssl-certificate docker run -it --rm -v "$(pwd)"/config/ssl:/tmp/docker-mailserver/ssl -h mail.my-domain.com -t mailserver/docker-mailserver generate-ssl-certificate
# Press enter # Press enter
# Enter a password when needed # Enter a password when needed

View file

@ -8,7 +8,7 @@ This project is Open Source. That means that you can contribute on enhancements,
!!! attention !!! attention
**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! **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!
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. 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.
@ -43,7 +43,7 @@ The development workflow is the following:
2. When your changes are validated, your branch is merged 2. When your changes are validated, your branch is merged
3. CI builds the new `:edge` image immediately and your changes will be includes in the next version release. 3. CI builds the new `:edge` image immediately and your changes will be includes in the next version release.
[wiki]: https://docker-mailserver.github.io/docker-mailserver [docs]: https://docker-mailserver.github.io/docker-mailserver/edge
[github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.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 [github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
[commit]: https://help.github.com/articles/closing-issues-via-commit-messages/ [commit]: https://help.github.com/articles/closing-issues-via-commit-messages/

View file

@ -27,7 +27,7 @@ We are going to use this docker based mailserver:
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
hostname: mail hostname: mail
domainname: example.org domainname: example.org
container_name: mail container_name: mail
@ -76,7 +76,7 @@ We are going to use this docker based mailserver:
On your server you may have to do it differently. On your server you may have to do it differently.
- Pull the docker image: `docker pull tvial/docker-mailserver:latest` - Pull the docker image: `docker pull mailserver/docker-mailserver:latest`
- 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`: - 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`:

View file

@ -60,7 +60,7 @@ Feel free to add your configuration if you achived the same goal using different
version: '2' version: '2'
services: services:
mail: mail:
image: tvial/docker-mailserver:release-v7.2.0 image: mailserver/docker-mailserver:release-v7.2.0
restart: always restart: always
networks: networks:
- proxy - proxy

View file

@ -187,7 +187,7 @@ Then with plain `docker-compose`:
```yaml ```yaml
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
volumes: volumes:
- ./cron/sa-learn:/etc/cron.d/sa-learn - ./cron/sa-learn:/etc/cron.d/sa-learn
``` ```
@ -199,7 +199,7 @@ version: "3.3"
services: services:
mail: mail:
image: tvial/docker-mailserver:latest image: mailserver/docker-mailserver:latest
# ... # ...
configs: configs:
- source: my_sa_crontab - source: my_sa_crontab
@ -351,7 +351,7 @@ proxy_interfaces = X.X.X.X (your public IP)
### What About Updates ### What About Updates
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. 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.
There is a page in the [Update and Cleanup][docs-maintenance] wiki page that explains how to use it the docker way. There is a section in the [Update and Cleanup][docs-maintenance] documentation page that explains how to use it the docker way.
### How to adjust settings with the `user-patches.sh` script ### How to adjust settings with the `user-patches.sh` script

View file

@ -6,7 +6,7 @@ title: Home
Please first have a look at the [`README.md`][github-file-readme] to setup and configure this server. Please first have a look at the [`README.md`][github-file-readme] to setup and configure this server.
This wiki provides you with advanced configuration, detailed examples, and hints. This documentation provides you with advanced configuration, detailed examples, and hints.
## Getting Started ## Getting Started

View file

@ -83,7 +83,7 @@ POSTSCREEN_ACTION=enforce
# 1 => only launch postfix smtp # 1 => only launch postfix smtp
SMTP_ONLY= SMTP_ONLY=
# Please read [the SSL page in the wiki](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SSL) for more information. # Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl) for more information.
# #
# empty => SSL disabled # empty => SSL disabled
# letsencrypt => Enables Let's Encrypt certificates # letsencrypt => Enables Let's Encrypt certificates