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

DOC: Updates links to new documentation #2465

Merged
merged 2 commits into from
Feb 29, 2024
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
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Please read the notes below and replace them with the description of you pull request

Make sure you follow the instructions in the [Developer Guide](https://intelmq.readthedocs.io/en/latest/dev/guide.html) - it describes how to run the test suite and which coding rules to follow.
Make sure you follow the instructions in the [Developer Guide](https://docs.intelmq.org/latest/dev/intro/) - it describes how to run the test suite and which coding rules to follow.

# Commits

Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@



3.2.2 (unreleased)
3.3.0 (unreleased)
------------------

### Configuration
Expand Down
13 changes: 8 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,12 @@ This file lists all changes which have an affect on the administration of IntelM
Please refer to the change log for a full list of changes.


3.2.2 Bugfix release (unreleased)
3.3.0 Feature release (unreleased)
---------------------------------

### Documentation
The documentation is now available at [docs.intelmq.org](https://docs.intelmq.org/). Documentation has been updated and restructured into User, Administrator and Developer Guide. It provides modern look with various quality of life improvements.

### Requirements

### Tools
Expand Down Expand Up @@ -59,7 +62,7 @@ Deb-packages of intelmq-api 3.2.0 are delayed for some distributions because of
#### Shadowserver Reports API collector
The misleading `country` parameter has been depreciated and a `reports` parameter has been added.
The backwards-compatibility will be removed in IntelMQ version 4.0.0.
See the [Shadowserver Reports API bot's documentation](https://intelmq.readthedocs.io/en/latest/user/bots.html#shadowserver-reports-api).
See the [Shadowserver Reports API bot's documentation](https://docs.intelmq.org/latest/user/bots/#shadowserver-reports-api).

#### GitHub Collector
GitHub removed the basic `Username/Password` Authentication in favor of personal access tokens. So the GitHub Collector uses an Personal Access Token for authentication [GitHub Documentation: Generate a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
Expand All @@ -76,7 +79,7 @@ IntelMQ previously supported two feeds: "Feodo Tracker IPs" (downloaded as CSV f
#### Field name checks
The field names for all data added to messages must match a pre-defined format.
The check which ensures this, was ineffective prior to this version and is effective again starting with version 3.1.0.
The [Data format documentation](https://intelmq.readthedocs.io/en/maintenance/dev/data-format.html#rules-for-keys) describes the required format.
The [Data format documentation](https://docs.intelmq.org/latest/dev/data-format/#rules-for-keys) describes the required format.

### Logrotate
The packaged configuration for *logrotate* falsely contained options applying to other programs' log files. This caused wrong ownership of log files.
Expand Down Expand Up @@ -172,7 +175,7 @@ New features:
* negation of arbitrary expressions and expression groups separated by brackets through a prepended `!`, e.g `! src.port :in [80, 443]`
* non-string values accepted by `add`/`add!`/`update`

The [sieve bot documentation](https://intelmq.readthedocs.io/en/maintenance/user/bots.html#intelmq-bots-experts-sieve-expert) has been updated to reflect on these new changes.
The [sieve bot documentation](https://docs.intelmq.org/latest/user/bots/#sieve) has been updated to reflect on these new changes.

### Data format
The classification scheme has been updated to better match the [Reference Security Incident Taxonomy (RSIT)](https://github.com/enisaeu/Reference-Security-Incident-Taxonomy-Task-Force/). The following labels were renamed, deleted or merged into others:
Expand Down Expand Up @@ -307,7 +310,7 @@ The `intelmqctl upgrade-config` command automatically fixes a configuration if t

Shadowserver changed some of their feeds, for more information see [Changes in Sinkhole and Honeypot Report Types and Formats](https://www.shadowserver.org/news/changes-in-sinkhole-and-honeypot-report-types-and-formats/). Support for the legacy feeds has not been removed yet.

The [Shadowserver Parser Bot documentation](https://intelmq.readthedocs.io/en/maintenance/user/bots.html#shadowserver-supported-reports) lists the supported feeds, as well as the legacy feeds.
The [Shadowserver Parser Bot documentation](https://docs.intelmq.org/latest/user/bots/#shadowserver) lists the supported feeds, as well as the legacy feeds.


2.3.2 Bugfix release (2021-04-27)
Expand Down
2 changes: 1 addition & 1 deletion contrib/eventdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ EventDB Utilities
It queries the database for all distinct malware names with the taxonomy "malicious-code" and sets another column to the malware family name.
- Apply Domain Suffix: Writes the public domain suffix to the `source.domain_suffix` / `destination.domain_suffix` columns, extracted from `source.fqdn` / `destination.fqdn`.
- PostgreSQL trigger keeping track of the oldest inserted/updated "time.source" data. This can be useful to (re-)generate statistics or aggregation data.
- SQL queries to set up a separate `raws` table, described in https://intelmq.readthedocs.io/en/latest/user/eventdb.html#separating-raw-values-in-postgresql-using-view-and-trigger
- SQL queries to set up a separate `raws` table, described in https://docs.intelmq.org/latest/admin/database/postgresql/#separating-raw-values-in-postgresql-using-view-and-trigger

Usage
-----
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bin/intelmqctl.py
Original file line number Diff line number Diff line change
Expand Up @@ -898,7 +898,7 @@ def check(self, no_connections=False, check_executables=True):
if orphan_queues:
check_logger.warning("Orphaned queues found: '%s'. Possible leftover from past reconfigurations "
"without cleanup. Have a look at the FAQ at "
"https://intelmq.readthedocs.io/en/maintenance/user/FAQ.html"
"https://docs.intelmq.org/latest/admin/faq/"
"#orphaned-queues", orphan_queues)

check_logger.info('Checking harmonization configuration.')
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/parsers/generic/parser_csv.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
from intelmq.lib.datatypes import TimeFormat

DATA_CONVERSIONS = {'json': lambda data: json.loads(data)}
DOCS = "https://intelmq.readthedocs.io/en/latest/guides/Bots.html#generic-csv-parser"
DOCS = "https://docs.intelmq.org/latest/user/bots/#generic-csv"


class GenericCsvParserBot(ParserBot):
Expand Down
4 changes: 2 additions & 2 deletions intelmq/lib/bot.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ def handle_sighup_signal_threading(signum: int,
self.logger.error('Multithreading is configured, but is not '
'available for this bot. Look at the FAQ '
'for a list of reasons for this. '
'https://intelmq.readthedocs.io/en/latest/user/FAQ.html'
'https://docs.intelmq.org/latest/admin/faq/'
'#multithreading-is-not-available-for-this-bot')
elif (getattr(self, 'instances_threads', 1) > 1 and
disable_multithreading):
Expand Down Expand Up @@ -1033,7 +1033,7 @@ def process_message(self, *messages: Union[libmessage.Message, dict]):
Return value is a dict with the complete pipeline state.
Multiple messages can be given as positional argument.
The pipeline needs to be configured accordinglit with BotLibSettings,
see https://intelmq.readthedocs.io/en/develop/dev/library.html
see https://docs.intelmq.org/latest/dev/library/

Access the output queue e.g. with return_value['output']
"""
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
include_package_data=True,
url='https://github.com/certtools/intelmq/',
project_urls={
'Documentation': 'https://intelmq.readthedocs.io/',
'Documentation': 'https://docs.intelmq.org/',
'Source and Issue Tracker': 'https://github.com/certtools/intelmq/',
},
license='AGPLv3',
Expand Down
Loading