Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links in documentation #3234

Merged
merged 10 commits into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To create your own plugin, see:
- the [plugin template][template] that includes all the boilerplate
- the [Write a Plugin][write-plugin] tutorial
- the [Plugins](plugins-doc) section of [the manual](https://haraka.github.io)
- the [Plugins][plugins-doc] section of [the manual](https://haraka.github.io)

## Installing NPM packaged plugins

Expand Down Expand Up @@ -109,7 +109,7 @@ Create a PR adding yours to this list.

[template]: https://github.com/haraka/haraka-plugin-template
[write-plugin]: https://github.com/haraka/Haraka/wiki/Write-a-Plugin
[plugins-doc]: https://haraka.github.io/manual/Plugins.html
[plugins-doc]: https://haraka.github.io/core/Plugins
[url-access]: https://github.com/haraka/haraka-plugin-access
[url-acc-files]: https://github.com/acharkizakaria/haraka-plugin-accounting-files/blob/master/README.md
[url-action-mailbox]: https://guides.rubyonrails.org/action_mailbox_basics.html
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,10 @@ SpamAssassin and a hacker on [Qpsmtpd][13].
[6]: https://github.com/haraka/Haraka/blob/master/docs/plugins/dkim_sign.md
[7]: https://en.wikipedia.org/wiki/Mail_delivery_agent
[8]: mailto:[email protected]
[9]: https://haraka.github.io/manual/plugins/spamassassin.html
[10]: https://haraka.github.io/manual/plugins/helo.checks.html
[11]: https://haraka.github.io/manual/plugins/dnsbl.html
[12]: https://github.com/haraka/Haraka/tree/master/plugins
[9]: https://haraka.github.io/plugins/spamassassin
[10]: https://haraka.github.io/plugins/helo.checks
[11]: https://haraka.github.io/plugins/dnsbl
[12]: https://github.com/haraka/Haraka/blob/master/Plugins.md
[13]: https://github.com/smtpd/qpsmtpd/
[15]: https://github.com/haraka/Haraka/issues
[16]: https://github.com/haraka/Haraka/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion config/access.domains
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
# aol.com
# [email protected]
#
# See full docs for details: http://haraka.github.io/manual/plugins/access.html
# See full docs for details: http://haraka.github.io/plugins/access
2 changes: 1 addition & 1 deletion docs/Connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ For low level use. This value is set when the remote host drops the connection.

* connection.results

Store results of processing in a structured format. See [docs/Results](http://haraka.github.io/manual/Results.html)
Store results of processing in a structured format. See [haraka-results](https://github.com/haraka/haraka-results)

6 changes: 3 additions & 3 deletions docs/Outbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ of CPUs that you have.

Default: true. Switch to false to disable TLS for outbound mail.

This uses the same `tls_key.pem` and `tls_cert.pem` files that the `tls`
plugin uses, along with other values in `tls.ini`. See the [tls plugin
docs](http://haraka.github.io/manual/plugins/tls.html) for information on generating those files.
This uses the same `tls_key.pem` and `tls_cert.pem` files that the `TLS`
plugin uses, along with other values in `tls.ini`. See the [TLS plugin
docs](http://haraka.github.io/plugins/tls) for information on generating those files.

Within `tls.ini` you can specify global options for the values `ciphers`, `minVersion`, `requestCert` and `rejectUnauthorized`, alternatively you can provide separate values by putting them under a key: `[outbound]`, such as:

Expand Down
2 changes: 1 addition & 1 deletion docs/Transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,6 @@ body in the same encoding.

* transaction.results

Store results of processing in a structured format. See [docs/Results](http://haraka.github.io/manual/Results.html)
Store results of processing in a structured format. See [haraka-results](https://github.com/haraka/haraka-results)

[1]: `Address` objects are address-rfc2821 objects. See https://github.com/haraka/node-address-rfc2821
2 changes: 1 addition & 1 deletion docs/plugins/connect.rdns_access.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## DEPRECATION NOTICE

See the [access](http://haraka.github.io/manual/plugins/access.html) plugin
See [haraka-plugin-access](https://github.com/haraka/haraka-plugin-access)
for upgrade instructions.


Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/mail_from.access.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## DEPRECATION NOTICE

See the [access](http://haraka.github.io/manual/plugins/access.html) plugin
See [haraka-plugin-access](https://github.com/haraka/haraka-plugin-access)
for upgrade instructions.


Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/rcpt_to.access.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## DEPRECATION NOTICE

See the [access](http://haraka.github.io/manual/plugins/access.html) plugin
See [haraka-plugin-access](https://github.com/haraka/haraka-plugin-access)
for upgrade instructions.


Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/relay.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This **relay** plugin provides Haraka with options for managing relay permission

## Authentication

One way to enable relaying is [authentication](http://haraka.github.io/manual.html) via the auth plugins. Successful authentication enables relaying during _that_ SMTP connection. To securely offer SMTP AUTH, the [tls](http://haraka.github.io/manual/plugins/tls.html) plugin and at least one auth plugin must be enabled and properly configured. When that requirement is met, the AUTH SMTP extension will be advertised to SMTP clients.
One way to enable relaying is authentication via the [auth plugins](http://haraka.github.io/plugins). Successful authentication enables relaying during _that_ SMTP connection. To securely offer SMTP AUTH, the [tls](http://haraka.github.io/plugins/tls) plugin and at least one auth plugin must be enabled and properly configured. When that requirement is met, the AUTH SMTP extension will be advertised to SMTP clients.

% nc mail.example.com 587
220 mail.example.com ESMTP Haraka 2.4.0 ready
Expand Down Expand Up @@ -118,7 +118,7 @@ Example:
[domains]
test.com = { "action": "accept" }

I think of *accept* as the equivalent of qmail's *rcpthosts*, or a misplaced Haraka `rcpt_to.*` plugin. The *accept* mechanism is another way to tell Haraka that a particular domain is one we accept mail for. The difference between this and the [rcpt_to.in_host_list](http://haraka.github.io/manual/plugins/rcpt_to.in_host_list.html) plugin is that this one also enables relaying.
Think of *accept* as the equivalent of qmail's *rcpthosts*, or a misplaced Haraka `rcpt_to.*` plugin. The *accept* mechanism is another way to tell Haraka that a particular domain is one we accept mail for. The difference between this and the [rcpt_to.in_host_list](http://haraka.github.io/plugins/rcpt_to.in_host_list) plugin is that this one also enables relaying.

* continue (mails are subject to further checks)

Expand Down
Loading