diff --git a/.imgbotconfig b/.imgbotconfig index 3dd2a071..6149559a 100644 --- a/.imgbotconfig +++ b/.imgbotconfig @@ -1,8 +1,6 @@ { - "schedule": "monthly", "ignoredFiles": [ "*inkscape.svg", ], - "compressWiki": "true", - "minKBReduced": null, + "minKBReduced": 1, } diff --git a/README.md b/README.md index a30a03f7..1736e5be 100644 --- a/README.md +++ b/README.md @@ -183,121 +183,17 @@ ## Features - 🎨 choose the style that fits you the most, including custom themes support - ...and more! +## User manual -## IP geolocation and network providers (ASN) +If you want to learn more, it’s recommended to check out the [Sniffnet Wiki](https://github.com/GyulyVGC/sniffnet/wiki), +a **comprehensive manual** to help you thoroughly master the application, from basic setup to the most advanced functionalities.
+The wiki includes step-by-step guides, examples of usage, tips, and answers to frequently asked questions. -
- - See details - -
- - Geolocation and network providers (ASN) refer to the remote IP address of each connection. They are retrieved performing lookups against [MMDB files](https://maxmind.github.io/MaxMind-DB/): - - > **Note** - > - > The MMDB (MaxMind database) format has been developed especially for IP lookup.
- > It is optimized to perform lookups on data indexed by IP network ranges quickly and efficiently.
- > It permits the best performance on IP lookups, and it's suitable for use in a production environment. - > - > This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com - - This file format potentially allows Sniffnet to execute hundreds of different IP lookups in a matter of a few milliseconds. - -
- - -## Supported network services - -
- - See details - -
- - Sniffnet supports more than 6000 services, including common upper layer protocols, trojans, and worms. - - Network services are inferred from the transport protocol and port number, - following the convention maintained by [IANA](https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml). - - Please, remember that this is just a convention: - - > **WARNING** - > - > The Internet Assigned Numbers Authority (IANA) is responsible for maintaining - > the official assignments of port numbers for specific uses.
- > However, many unofficial uses of well-known port numbers occur in practice. - - Sniffnet's list of services is generated from [Nmap's service collection](https://nmap.org/book/nmap-services.html) - and is available in the file [`services.txt`](https://raw.githubusercontent.com/GyulyVGC/sniffnet/main/services.txt). - -
- - -## Keyboard shortcuts - -
- - See details - -
- -Some keyboard shortcuts are available to improve the efficiency of use and the overall user experience. - -If you want to suggest a different key combination for one of the existing shortcuts or if you want to propose a new shortcut, -have a look at [this](https://github.com/GyulyVGC/sniffnet/issues/97) issue. - -The currently usable hotkeys are reported in the following. - -> **Note** -> -> On macOS, use the cmd key instead of ctrl - -
- -| Event | Shortcut keys | -|---------------------------------------------------------------|---------------------------------------------------------------------------------| -| Quit the application | ctrl+Q | -| Open full report | ctrl+O | -| Open settings | ctrl+, | -| Clear all notifications | ctrl+D | -| Interrupt the ongoing analysis | ctrl+backspace | -| Start the analysis and confirm modal actions | enter | -| Close settings and modal popups | esc | -| Switch from a tab to the next (or previous) one | tab (or shift+tab) | -| Change inspect connections page to the next (or previous) one | ctrl+rightArrow (or ctrl+leftArrow) | - -
- -
- -## Custom themes -
- - See details - - Custom themes are specified as a TOML file. - - The TOML must follow this format: - - ```toml - # all colors are in RGB/RGBA hexadecimal. - primary = "#303446" # background color - secondary = "#a6d189" # header, footer, and incoming connections color - outgoing = "#f4b8e4" # outgoing connections color - text_body = "#c6d0f5" # body text color - text_headers = "#232634" # header and footer text color - starred = "#e5c890aa" # favorites' star color - ``` - - The example theme above uses colors from [Catppuccin](https://github.com/catppuccin/catppuccin). - - You can also check the [`resources/themes`](https://github.com/GyulyVGC/sniffnet/tree/main/resources/themes) folder, - which contains sample TOML files with additional themes. - - To use a custom theme for your instance of Sniffnet, specify the path of your TOML file in the application's - settings (at the bottom of the style tab). -
+

+ +Sniffnet Wiki + +

## Troubleshooting @@ -324,7 +220,7 @@ ### Rendering problems ICED_BACKEND=tiny-skia ``` -### ***In any case don't hesitate to [open an issue](https://github.com/GyulyVGC/sniffnet/issues), and I will do my best to help you!*** +### ***In any case don't hesitate to [open an issue](https://github.com/GyulyVGC/sniffnet/issues/new/choose), and I will do my best to help you!*** diff --git a/resources/logos/wiki/wiki_glyph.svg b/resources/logos/wiki/wiki_glyph.svg new file mode 100644 index 00000000..fc710371 --- /dev/null +++ b/resources/logos/wiki/wiki_glyph.svg @@ -0,0 +1,133 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/resources/logos/wiki/wikilogo-inkscape.svg b/resources/logos/wiki/wikilogo-inkscape.svg new file mode 100644 index 00000000..efd135c2 --- /dev/null +++ b/resources/logos/wiki/wikilogo-inkscape.svg @@ -0,0 +1,197 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/resources/logos/wiki/wikilogo.png b/resources/logos/wiki/wikilogo.png new file mode 100644 index 00000000..150f85b7 Binary files /dev/null and b/resources/logos/wiki/wikilogo.png differ diff --git a/resources/logos/wiki/wikilogo.svg b/resources/logos/wiki/wikilogo.svg new file mode 100644 index 00000000..84e95812 --- /dev/null +++ b/resources/logos/wiki/wikilogo.svg @@ -0,0 +1,157 @@ + + + + + + + + + + + + + + + + + + + + +