From 463bc967d229a55de6522f4b08d3a6427a3f8f67 Mon Sep 17 00:00:00 2001 From: wernerfred <20406381+wernerfred@users.noreply.github.com> Date: Mon, 1 Mar 2021 21:32:45 +0100 Subject: [PATCH] docs(fix): Update wiki references to the new docs url Additionally replaces old references to `tvial` images with the new `mailserver` docker image name. --- .github/ISSUE_TEMPLATE/bug_report.md | 14 +++++++------- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- .github/pull_request_template.md | 2 +- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 4 ++-- ENVIRONMENT.md | 4 ++-- README.md | 12 ++++++------ docs/content/config/advanced/auth-ldap.md | 2 +- docs/content/config/advanced/full-text-search.md | 2 +- docs/content/config/advanced/kubernetes.md | 2 +- docs/content/config/security/ssl.md | 6 +++--- .../contributing/issues-and-pull-requests.md | 4 ++-- .../examples/tutorials/basic-installation.md | 4 ++-- .../examples/tutorials/mailserver-behind-proxy.md | 2 +- docs/content/faq.md | 6 +++--- docs/content/index.md | 2 +- mailserver.env | 2 +- 17 files changed, 37 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 37ef22cb..c54d02aa 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,21 +13,21 @@ Possible answers to your issue https://github.com/docker-mailserver/docker-mailserver#requirements * Email seen as spam: - https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-SPF - https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-DKIM + https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/spf + https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim * 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 - 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. * 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 - https://github.com/docker-mailserver/docker-mailserver/wiki +* The documentation + https://docker-mailserver.github.io/docker-mailserver/edge * Open issues https://github.com/docker-mailserver/docker-mailserver/issues diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 9bd2dd71..ed2eb258 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,8 +2,8 @@ blank_issues_enabled: false contact_links: - - name: Wiki - url: https://github.com/docker-mailserver/docker-mailserver/wiki + - name: Documentation + url: https://docker-mailserver.github.io/docker-mailserver/edge about: Extended documentaton - visit this first before opening issues - name: Default Documentation url: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0a739ebf..9e6fda57 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,6 +20,6 @@ Fixes # (issue) - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] 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 - [ ] New and existing unit tests pass locally with my changes diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 63216313..17e8fe48 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12ec220b..44465d0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # 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. [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 -**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**. diff --git a/ENVIRONMENT.md b/ENVIRONMENT.md index 89f60de2..ae3c0089 100644 --- a/ENVIRONMENT.md +++ b/ENVIRONMENT.md @@ -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. - 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 @@ -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 - 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 diff --git a/README.md b/README.md index 1518b0f3..330a23a1 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) ## Included Services - [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/) - [Spamassasin](http://spamassassin.apache.org/) supporting custom rules - [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) - [Postgrey](https://postgrey.schweikert.ch/) - [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 -- Basic [Sieve support](https://github.com/docker-mailserver/docker-mailserver/wiki/Configure-Sieve-filters) using dovecot +- [Setup script](https://docker-mailserver.github.io/docker-mailserver/edge/config/setup.sh) to easily configure and maintain your mailserver +- Basic [Sieve support](https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-sieve) using dovecot - SASLauthd with LDAP auth - Persistent data and state - [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 - 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 @@ -108,7 +108,7 @@ chmod a+x ./setup.sh - don't quote your values - 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. -- 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 @@ -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). 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 diff --git a/docs/content/config/advanced/auth-ldap.md b/docs/content/config/advanced/auth-ldap.md index e369d310..8ce8e2c5 100644 --- a/docs/content/config/advanced/auth-ldap.md +++ b/docs/content/config/advanced/auth-ldap.md @@ -39,7 +39,7 @@ version: '2' services: mail: - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest hostname: mail domainname: domain.com container_name: mail diff --git a/docs/content/config/advanced/full-text-search.md b/docs/content/config/advanced/full-text-search.md index 29a88d58..8a626bb4 100644 --- a/docs/content/config/advanced/full-text-search.md +++ b/docs/content/config/advanced/full-text-search.md @@ -20,7 +20,7 @@ The [dovecot-solr Plugin](https://wiki2.dovecot.org/Plugins/FTS/Solr) is used in restart: always mailserver: - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest ... volumes: ... diff --git a/docs/content/config/advanced/kubernetes.md b/docs/content/config/advanced/kubernetes.md index bf4d90cd..c3f4c86f 100644 --- a/docs/content/config/advanced/kubernetes.md +++ b/docs/content/config/advanced/kubernetes.md @@ -144,7 +144,7 @@ spec: # mountPath: /tmp/files containers: - name: docker-mailserver - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest imagePullPolicy: Always volumeMounts: - name: config diff --git a/docs/content/config/security/ssl.md b/docs/content/config/security/ssl.md index 95a8f7f1..c151e2e4 100644 --- a/docs/content/config/security/ssl.md +++ b/docs/content/config/security/ssl.md @@ -190,7 +190,7 @@ The second part of the setup is the actual mail container. So, in another folder version: '2' services: mail: - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest hostname: ${HOSTNAME} domainname: ${DOMAINNAME} container_name: ${CONTAINER_NAME} @@ -379,7 +379,7 @@ This allows for support of wild card certificates: `SSL_DOMAIN=*.example.com`. H version: '3.8' services: mail: - image: tvial/docker-mailserver:stable + image: mailserver/docker-mailserver:stable hostname: mail domainname: example.com 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: ```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 # Enter a password when needed diff --git a/docs/content/contributing/issues-and-pull-requests.md b/docs/content/contributing/issues-and-pull-requests.md index 801e06f0..6ae3cb48 100644 --- a/docs/content/contributing/issues-and-pull-requests.md +++ b/docs/content/contributing/issues-and-pull-requests.md @@ -8,7 +8,7 @@ This project is Open Source. That means that you can contribute on enhancements, !!! 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. @@ -43,7 +43,7 @@ The development workflow is the following: 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. -[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-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md [commit]: https://help.github.com/articles/closing-issues-via-commit-messages/ diff --git a/docs/content/examples/tutorials/basic-installation.md b/docs/content/examples/tutorials/basic-installation.md index 7b63fab0..50f934ff 100644 --- a/docs/content/examples/tutorials/basic-installation.md +++ b/docs/content/examples/tutorials/basic-installation.md @@ -27,7 +27,7 @@ We are going to use this docker based mailserver: services: mail: - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest hostname: mail domainname: example.org 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. -- 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`: diff --git a/docs/content/examples/tutorials/mailserver-behind-proxy.md b/docs/content/examples/tutorials/mailserver-behind-proxy.md index febccbf7..cc4c5620 100644 --- a/docs/content/examples/tutorials/mailserver-behind-proxy.md +++ b/docs/content/examples/tutorials/mailserver-behind-proxy.md @@ -60,7 +60,7 @@ Feel free to add your configuration if you achived the same goal using different version: '2' services: mail: - image: tvial/docker-mailserver:release-v7.2.0 + image: mailserver/docker-mailserver:release-v7.2.0 restart: always networks: - proxy diff --git a/docs/content/faq.md b/docs/content/faq.md index e142bbe4..d55e56f8 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -187,7 +187,7 @@ Then with plain `docker-compose`: ```yaml services: mail: - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest volumes: - ./cron/sa-learn:/etc/cron.d/sa-learn ``` @@ -199,7 +199,7 @@ version: "3.3" services: mail: - image: tvial/docker-mailserver:latest + image: mailserver/docker-mailserver:latest # ... configs: - source: my_sa_crontab @@ -351,7 +351,7 @@ proxy_interfaces = X.X.X.X (your public IP) ### 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. -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 diff --git a/docs/content/index.md b/docs/content/index.md index 14485769..923ee83c 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -6,7 +6,7 @@ title: Home 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 diff --git a/mailserver.env b/mailserver.env index 0eb4e328..a039a779 100644 --- a/mailserver.env +++ b/mailserver.env @@ -83,7 +83,7 @@ POSTSCREEN_ACTION=enforce # 1 => only launch postfix smtp 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 # letsencrypt => Enables Let's Encrypt certificates