Skip to content

Commit

Permalink
Move some pages from doc to tutorials directory
Browse files Browse the repository at this point in the history
  • Loading branch information
moisseev committed Apr 25, 2024
1 parent 6e0a7bf commit 40a25de
Show file tree
Hide file tree
Showing 34 changed files with 96 additions and 96 deletions.
8 changes: 4 additions & 4 deletions _includes/top.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@
</li>
<li>Installation and Administration
<ul>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/quickstart.html">Quick start</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/tutorials/quickstart.html">Quick start</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/faq.html">FAQ</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/integration.html">MTA integration</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/migration.html">Upgrading notes</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/tutorials/integration.html">MTA integration</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/tutorials/migration.html">Upgrading notes</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/webui/">Rspamd WebUI</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/gtube_patterns.html">GTUBE-like test patterns</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/tutorials/migrate_sa.html">Migrating from SA</a></li>
Expand Down Expand Up @@ -124,7 +124,7 @@
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/lua/">Lua API reference</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/developers/examples.html">Lua rules examples</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/developers/writing_rules.html">Writing Rspamd rules</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/fuzzy_storage.html">Creating your fuzzy storage</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/tutorials/fuzzy_storage.html">Creating your fuzzy storage</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/developers/architecture.html">Architecture information</a></li>
<li><a class="dropdown-item" href="{{ site.baseurl }}/doc/developers/protocol.html">Protocol documentation</a></li>
</ul>
Expand Down
8 changes: 4 additions & 4 deletions _layouts/doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@
<li class="r-docs-subnav list-group-item">
<a href="#">Tutorials and Guides</a>
<ul>
<li><a href="{{ site.baseurl }}/doc/quickstart.html">Quick start</a></li>
<li><a href="{{ site.baseurl }}/doc/integration.html">MTA integration</a></li>
<li><a href="{{ site.baseurl }}/doc/migration.html">Upgrading</a></li>
<li><a href="{{ site.baseurl }}/doc/fuzzy_storage.html">Own fuzzy storage</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/quickstart.html">Quick start</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/integration.html">MTA integration</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/migration.html">Upgrading</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/fuzzy_storage.html">Own fuzzy storage</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/redis_replication.html">Replication in Redis</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/scanning_outbound.html">How to scan outbound emails</a></li>
<li><a href="{{ site.baseurl }}/doc/tutorials/stunnel_setup.html">Setup stunnel to protect Redis</a></li>
Expand Down
2 changes: 1 addition & 1 deletion _posts/2014-09-11-rspamd-0.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ categories: release update
---

After a year of development I'm proud to present you the new major release of rspamd - 0.7.0. This is the first release of `0.7` branch and it includes a lot of improvement and reorganization.
I have added the document that describes migration from rspamd 0.6 to rspamd 0.7: <https://rspamd.com/doc/migration.html>
I have added the document that describes migration from rspamd 0.6 to rspamd 0.7: ({{ site.baseurl }}/doc/tutorials/migration.html)
Unfortunately, due to the poor design of the `LUA` API used in the old rspamd versions, several incompatibilities are introduced. Please consult with the migration document that describes how to deal
with those incompatibilities.

Expand Down
2 changes: 1 addition & 1 deletion _posts/2015-01-02-rspamd-0.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ I have added the normalization algorithm for the target language using [snowball
the first forms of all words in a text improving thus fuzzy matching quality by removing meaningless parts.

Rspamd 0.8 is heavily tested in production environments and I consider it as a production ready release. No manual migration is required for rspamd 0.7 users, however, if you use
more old versions of rspamd then you should check the [migration guide]({{ site.url }}{{ site.baseurl }}/doc/migration.html).
more old versions of rspamd then you should check the [migration guide]({{ site.baseurl }}/doc/tutorials/migration.html).

As usually, please feel free to ask any questions in rspamd mailing list or IRC discussion channel (#rspamd at OFTC).
10 changes: 5 additions & 5 deletions _posts/2015-09-17-rspamd-1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ out of the box:
- improving documentation
- improving installation

Among new rules, rspamd now includes an extensive [whitelist]({{ site.url }}{{ site.baseurl }}/doc/modules/whitelist.html) for valid mail (e.g. with valid combinations of DKIM/DMARC/SPF).
Among new rules, rspamd now includes an extensive [whitelist]({{ site.baseurl }}/doc/modules/whitelist.html) for valid mail (e.g. with valid combinations of DKIM/DMARC/SPF).
DMARC module is now also enabled by default. The new `ip_score` module is intended to score messages based on theirs IP reputation.

New statistics includes `sqlite3` [statistics]({{ site.url }}{{ site.baseurl }}/doc/configuration/statistic.html) with such features as per user and per language statistics. Moreover, rspamd
now takes metadata, such as messages' headers or images into consideration when generating statistical tokens. The updated [pre built statistics]({{ site.url }}{{ site.baseurl }}/rspamd_statistics/) is also
New statistics includes `sqlite3` [statistics]({{ site.baseurl }}/doc/configuration/statistic.html) with such features as per user and per language statistics. Moreover, rspamd
now takes metadata, such as messages' headers or images into consideration when generating statistical tokens. The updated [pre built statistics]({{ site.baseurl }}/rspamd_statistics/) is also
available for download.

The main architectural improvement in rspamd that was introduced in 1.0 was the ability to add dependencies between rules. Previosuly, the only way to separate asynchronous rules from each
Expand All @@ -34,11 +34,11 @@ Among other notable changes are:
- New logger

Many other things has been changed as well. However, I've tried to preserve backwards compatibility with `0.9`/ The main incompatible issues are listed in the
[migration page]({{ site.url }}{{ site.baseurl }}/doc/migration.html).
[migration page]({{ site.baseurl }}/doc/tutorials/migration.html).

The full list of *major* changes could be found here: <http://git.io/vnJvF>. Moreover, there were a lot of minor changes, improvements and features intorduces with this version.

If you'd like to install the new rspamd version you can check the [following document]({{ site.url }}{{ site.baseurl }}/doc/quickstart.html) that describes the available distributions in binary and source forms.
If you'd like to install the new rspamd version you can check the [following document]({{ site.baseurl }}/doc/tutorials/quickstart.html) that describes the available distributions in binary and source forms.

I'd like to thank all rspamd contibutors especially [Andrew Lewis](https://github.com/fatalbanana/) for his contributions to lua modules and the overall `rspamd` development, and [Andrey Zverev](https://github.com/andrejzverev) for
his kind advices and patience while testing bugfixes.
Expand Down
4 changes: 2 additions & 2 deletions _posts/2016-01-18-rspamd-1.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ A number of features that I was asked constantly about have been added to rspamd

There is also major performance improvement: [hyperscan](https://github.com/01org/hyperscan) engine support for optimizing regular expressiosn execution.

With this version, I have added a lot of documentation, including [tutorials]({{ site.url }}{{ site.baseurl }}/doc/tutorials/) and improved [quick start guide]({{ site.baseurl }}/doc/quickstart.html).
With this version, I have added a lot of documentation, including [tutorials]({{ site.baseurl }}/doc/tutorials/) and improved [quick start guide]({{ site.baseurl }}/doc/tutorials/quickstart.html).

Here is the full changelog for this version available on GitHub: <https://github.com/vstakhov/rspamd/blob/1.1.0/ChangeLog>

The new version is almost 100% backward compatible with `1.0` branch but please check the [migration]({{ site.baseurl }}/doc/migration.html) document if you are using per-user statistics and rspamd-1.0.
The new version is almost 100% backward compatible with `1.0` branch but please check the [migration]({{ site.baseurl }}/doc/tutorials/migration.html) document if you are using per-user statistics and rspamd-1.0.

Here are some graph of rspamd performance on scanning:

Expand Down
2 changes: 1 addition & 1 deletion _posts/2016-03-21-rspamd-1.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ The new release is scanned with [Coverity scan](https://scan.coverity.com/) and

The complete log of changes can be found here: <https://github.com/vstakhov/rspamd/blob/1.2.0/ChangeLog>

There are many important additions in the documentation shipped with rspamd. There is now a [frequently asked questions]({{ site.baseurl }}/doc/faq.html) article that describes many aspects of practical rspamd use. The [quick start guide]({{ site.baseurl }}/doc/quickstart.html) has also been updated to improve new users' experience when installing and running rspamd.
There are many important additions in the documentation shipped with rspamd. There is now a [frequently asked questions]({{ site.baseurl }}/doc/faq.html) article that describes many aspects of practical rspamd use. The [quick start guide]({{ site.baseurl }}/doc/tutorials/quickstart.html) has also been updated to improve new users' experience when installing and running rspamd.

[Rmilter]({{ site.baseurl }}/rmilter/) has been also upgraded to version `1.7.5` which fixes important greylisting and clamav issues. The rmilter changelog is available here: <https://github.com/vstakhov/rmilter/blob/1.7.5/ChangeLog>
4 changes: 2 additions & 2 deletions _posts/2016-07-25-rspamd-1.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We understand the importance of testing when building spam filtering engines. Mo

### Fuzzy storage mirroring

[Fuzzy hashes]({{ site.baseurl }}/doc/modules/fuzzy_check.html) are a powerful method to filter spam mail. In version 1.3, Rspamd supports hash mirroring enabling master-slave replication for different storages. Furthermore, it is possible to organise collections of hashes from multiple sources. The synchronization structure is quite simple but it allows for building distributed systems providing the necessary level of redundancy and security. All these features are described in the [fuzzy storage operational guide]({{ site.baseurl }}/doc/fuzzy_storage.html).
[Fuzzy hashes]({{ site.baseurl }}/doc/modules/fuzzy_check.html) are a powerful method to filter spam mail. In version 1.3, Rspamd supports hash mirroring enabling master-slave replication for different storages. Furthermore, it is possible to organise collections of hashes from multiple sources. The synchronization structure is quite simple but it allows for building distributed systems providing the necessary level of redundancy and security. All these features are described in the [fuzzy storage operational guide]({{ site.baseurl }}/doc/tutorials/fuzzy_storage.html).

<center><img class="img-fluid" src="{{ site.baseurl }}/img/fuzzy_mirroring.png" width="50%"></center>

Expand Down Expand Up @@ -62,4 +62,4 @@ There are various improvements in the Rspamd web interface. For example, it now

Rspamd 1.3 also includes other changes that improve stability, filtering quality and performance, for example faster hash function selection. There are many critical bug fixes that were not backported to the 1.2 branch, for instance, major Redis statistics rework (which can now be used in highly loaded production environments). Many rules have been rescored and reworked. There are also many bug fixes to the URL detection logic and phishing detection. The [`chartable`]({{ site.baseurl }}/doc/modules/chartable.html) module has been completely rewritten to provide more useful homograph detection. There are massive changes to the documentation: new guides, better [FAQ]({{ site.baseurl }}/doc/faq.html) section and completely reworked [Rmilter]({{ site.baseurl }}/rmilter/) section.

**WARNING**: There are a couple of incompatible changes for Rmilter, so please take a look at [the migration document]({{ site.baseurl }}/doc/migration.html).
**WARNING**: There are a couple of incompatible changes for Rmilter, so please take a look at [the migration document]({{ site.baseurl }}/doc/tutorials/migration.html).
2 changes: 1 addition & 1 deletion _posts/2016-11-21-rspamd-1.4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ There are many major improvements to the Rspamd Web Interface including the foll

## Conclusions

Rspamd 1.4 and Rmilter 1.10 are the current stable branches and all users are recommended to update their Rspamd versions. Please read the [migration guide]({{ site.baseurl }}/doc/migration.html) if you are unsure about the upgrade process.
Rspamd 1.4 and Rmilter 1.10 are the current stable branches and all users are recommended to update their Rspamd versions. Please read the [migration guide]({{ site.baseurl }}/doc/tutorials/migration.html) if you are unsure about the upgrade process.
2 changes: 1 addition & 1 deletion _posts/2017-03-01-rspamd-1.5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Rspamd 1.5 has been released"
categories: announce
---

We are pleased to announce the new major Rspamd release `1.5` today. This release includes a lot of major reworks, new cool features and a significant number of bugs being fixed. The update from the previous versions shouldn't be hard, however, please check the [migration document]({{ site.baseurl }}/doc/migration.html) to be sure that the new version will not break the existing configuration.
We are pleased to announce the new major Rspamd release `1.5` today. This release includes a lot of major reworks, new cool features and a significant number of bugs being fixed. The update from the previous versions shouldn't be hard, however, please check the [migration document]({{ site.baseurl }}/doc/tutorials/migration.html) to be sure that the new version will not break the existing configuration.

Here is a list of major changes for this version.

Expand Down
2 changes: 1 addition & 1 deletion _posts/2017-06-12-rspamd-1.6.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Rspamd 1.6.0 has been released"
categories: announce
---

Today, we release the new major version `1.6.0` of Rspamd. The most significant change in this version is the addition of Milter protocol support in Rspamd. Therefore, Rmilter project is finally turned to the abandoned state and should not be used in new installations. All Rmilter users should consider migration to Rspamd milter support. This release has some incompatible changes so please check the [migration guide]({{ site.url }}{{ site.baseurl }}/doc/migration.html).
Today, we release the new major version `1.6.0` of Rspamd. The most significant change in this version is the addition of Milter protocol support in Rspamd. Therefore, Rmilter project is finally turned to the abandoned state and should not be used in new installations. All Rmilter users should consider migration to Rspamd milter support. This release has some incompatible changes so please check the [migration guide]({{ site.baseurl }}/doc/tutorials/migration.html).

Here is the list of most noticeable changes. The full list is available on the [changes page]({{ site.url }}{{ site.baseurl }}/changes.html).

Expand Down
2 changes: 1 addition & 1 deletion _posts/2018-03-12-rspamd-1.7.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We have decided to eliminate the concept of stable branches since it makes the p

## Migration notes

Please read [migration notes]({{ site.url }}{{ site.baseurl }}/doc/migration.html). We believe that no explicit configuration changes are required to upgrade from Rspamd 1.6.6.
Please read [migration notes]({{ site.baseurl }}/doc/tutorials/migration.html). We believe that no explicit configuration changes are required to upgrade from Rspamd 1.6.6.

## New features in Rspamd 1.7

Expand Down
12 changes: 6 additions & 6 deletions _posts/2018-09-24-rspamd-1.8.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ categories: announce

We have released **Rspamd 1.8.0** today.

There are couple of the incompatibilities introduced, hence, please check the [migration notes](https://rspamd.com/doc/migration.html), especially if you use [clickhouse module](https://rspamd.com/doc/modules/clickhouse.html) or [users settings](https://rspamd.com/doc/configuration/settings.html).
There are couple of the incompatibilities introduced, hence, please check the [migration notes]({{ site.baseurl }}/doc/tutorials/migration.html), especially if you use [clickhouse module]({{ site.baseurl }}/doc/modules/clickhouse.html) or [users settings]({{ site.baseurl }}/doc/configuration/settings.html).

## The most important features and fixes

* New [**selectors framework**](https://rspamd.com/doc/configuration/selectors.html)
* New [**selectors framework**]({{ site.baseurl }}/doc/configuration/selectors.html)

This framework allows to combine and process different data extracted from messages and use that in different plugins, such as [multimap](https://rspamd.com/doc/modules/multimap.html), [reputation](https://rspamd.com/doc/modules/reputation.html) or [ratelimits](https://rspamd.com/doc/modules/ratelimit.html). It is also possible to use data extracted in Rspamd [regular expressions](https://rspamd.com/doc/modules/regexp.html).
This framework allows to combine and process different data extracted from messages and use that in different plugins, such as [multimap]({{ site.baseurl }}/doc/modules/multimap.html), [reputation]({{ site.baseurl }}/doc/modules/reputation.html) or [ratelimits]({{ site.baseurl }}/doc/modules/ratelimit.html). It is also possible to use data extracted in Rspamd [regular expressions]({{ site.baseurl }}/doc/modules/regexp.html).

* [**Coroutines** API]({{ site.baseurl }}/doc/developers/sync_async.html) support in Lua

Now you can write code in a usual imperative manner but you still will not block any other tasks. Each potentially blocking operation creates a yielding-point. In turn, this means the code is suspended until the operation is done (just like blocking) and resumes only when there is some result. Meanwhile, other tasks are processed as usual.

* [Clickhouse](https://rspamd.com/doc/modules/clickhouse.html) optimization
* [Clickhouse]({{ site.baseurl }}/doc/modules/clickhouse.html) optimization

Rspamd now uses a flat table to optimize ClickHouse SQL requests. In fact, joins are not recommended by the ClickHouse developers as multiple joins have proven to be slow. Hence, Rspamd has moved all data to a single table. Schema migration is done automatically, however, please read the [migration notes](https://rspamd.com/doc/migration.html) in case of any doubts. Old data is not migrated nor deleted automatically.
Rspamd now uses a flat table to optimize ClickHouse SQL requests. In fact, joins are not recommended by the ClickHouse developers as multiple joins have proven to be slow. Hence, Rspamd has moved all data to a single table. Schema migration is done automatically, however, please read the [migration notes]({{ site.baseurl }}/doc/tutorials/migration.html) in case of any doubts. Old data is not migrated nor deleted automatically.

There is now optional data retention support in the ClickHouse module. You can set retention policies for the data stored in Clickhouse to conform different regulations (e.g. GDPR).

Expand All @@ -36,7 +36,7 @@ There are couple of the incompatibilities introduced, hence, please check the [m

We have located and fixed various hidden issues caused by async rules chaining. It might cause inconsistencies in the dependencies processing, crashes in rare cases and other "bad things".

* Various [Web Interface](https://rspamd.com/webui/) improvements and fixes
* Various [Web Interface]({{ site.baseurl }}/webui/) improvements and fixes

There are multiple improvements and fixes in the Web Interface. In particular, the issues with cluster support and aggregation have been addressed.

Expand Down
Loading

0 comments on commit 40a25de

Please sign in to comment.