You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/usage.md
+17-28Lines changed: 17 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,49 +4,38 @@ sidebar_position: 3
4
4
5
5
# Usage Overview
6
6
7
-
ServerRawler is a powerful tool for scanning Minecraft servers, designed for efficiency and flexibility. This section provides a comprehensive guide on how to operate ServerRawler, from starting the crawler to understanding its command-line arguments and interpreting its output.
8
-
9
-
## Starting ServerRawler
10
-
11
-
Once ServerRawler is installed and configured, you can initiate its operations. Navigate to the project's root directory in your terminal.
12
-
13
-
If you prefer to use a custom configuration file, look at the [--config](./usage/arguments/scan) argument.
7
+
This page gives you an overview about all commands and arguments of ServerRawler in the terminal.
8
+
For detailed information about each command and argument, click on the links to navigate to their documentation pages.
14
9
15
10
## Command Line Arguments
16
11
17
-
ServerRawler's behavior can be customized using a variety of command-line arguments. Each argument provides granular control over logging, scanning, IP generation, and more. Click on any argument below for detailed information and examples.
18
-
19
12
:::tip
20
-
For a quick overview of all available commands directly in your terminal, run `ServerRawler --help`.
13
+
For a quick overview of all available commands directly in your terminal, run `./ServerRawler --help`.
21
14
:::
22
15
23
16
### General Arguments
24
17
25
-
*[**`--log`**](./usage/arguments/log): Set the threshold for console output.
26
-
*[**`--no-database`**](./usage/arguments/no-database): Prevent data from being saved to the database.
27
-
*[**`--max-network-tasks`**](./usage/arguments/max-network-tasks): Define the maximum concurrent network operations.
28
-
*[**`--config`**](./usage/arguments/config): Specify a custom configuration file.
29
-
30
-
### Utility & Debugging Arguments
31
-
32
-
*[**`--ping`**](./usage/arguments/ping): Perform a Server List Ping (SLP) check.
33
-
*[**`--query`**](./usage/arguments/query): Retrieve detailed server info via Query protocol.
34
-
*[**`--join`**](./usage/arguments/join): Simulate a player login for authentication/whitelist checks.
35
-
*[**`--convert-image`**](./usage/arguments/convert-image): Convert Base64 strings to image files.
36
-
*[**`--generate-ips`**](./usage/arguments/generate-ips): Generate random IPv4 addresses and save them to a file.
37
-
*[**`--cidr`**](./usage/arguments/cidr): Configure an IP range for generation or scanning.
18
+
-[**`--log`**](./usage/arguments/log): Set the threshold for console output.
19
+
-[**`--no-database`**](./usage/arguments/no-database): Prevent data from being saved to the database.
20
+
-[**`--config`**](./usage/arguments/config): Specify a custom configuration file.
21
+
-[**`--cidr`**](./usage/arguments/cidr): Configure an IP range for IP generation.
38
22
39
-
### Scanning & Crawling Arguments
23
+
### Commands
40
24
41
-
*[**`--crawl`**](./usage/arguments/crawl): Start a continuous crawling loop for discovering servers.
42
-
*[**`--scan`**](./usage/arguments/scan): Scan IP addresses from a text file.
25
+
-[**`ping`**](./usage/commands/ping): Perform a Server List Ping (SLP) check.
26
+
-[**`query`**](./usage/commands/query): Retrieve detailed server info via Query protocol.
27
+
-[**`join`**](./usage/commands/join): Simulate a player login for authentication/whitelist checks.
28
+
-[**`convert-img`**](./usage/commands/convert-image): Convert Base64 strings to image files.
29
+
-[**`generate`**](./usage/commands/generate-ips): Generate random IPv4 addresses and save them to a file.
30
+
-[**`crawl`**](./usage/commands/crawl): Start a continuous crawling loop for discovering servers.
31
+
-[**`scan`**](./usage/commands/scan): Scan IP addresses from a text file.
43
32
44
33
## Output
45
34
46
35
ServerRawler provides real-time feedback through console logs, indicating its progress, any discovered servers, and errors encountered.
47
36
48
-
* Successfully discovered server data, if database saving is enabled, will be stored in your configured PostgreSQL database.
49
-
* Logs are color-coded to easily distinguish between information, warnings, errors, and successes.
37
+
- Successfully discovered server data, if database saving is enabled, will be stored in your configured PostgreSQL database.
38
+
- Logs are color-coded to easily distinguish between information, warnings, errors, and successes.
Configures an IP range in CIDR (Classless Inter-Domain Routing) format to restrict the scope of IP generation (`--generate-ips`) or crawling (`--crawl`) operations. This allows focusing on specific networks or segments.
9
+
## Description
10
10
11
-
:::info
12
-
CIDR notation specifies an IP address and a prefix length, indicating the number of bits in the IP address that represent the network prefix. For example, `192.168.1.0/24` covers all IP addresses from `192.168.1.0` to `192.168.1.255`.
11
+
Configures an IP range in CIDR (Classless Inter-Domain Routing) format to restrict the scope of IP generation oprations. This allows focusing on specific networks or segments.
12
+
13
+
:::info[What is CIDR?]
14
+
CIDR (Classless Inter-Domain Routing) is a method for allocating IP addresses and routing Internet Protocol packets. It replaces the older system based on classes A, B, and C. CIDR notation is a compact representation of an IP address and its associated network mask. It consists of an IP address, followed by a slash (`/`), and then a number that indicates the length of the network prefix in bits. For example, `192.168.1.0/24` covers all IP addresses from `192.168.1.0` to `192.168.1.255`.
13
15
:::
14
16
15
17
## Usage
16
18
17
19
```bash
18
-
ServerRawler --cidr <IP_RANGE>
20
+
./ServerRawler<Command> --cidr <IP_RANGE>
19
21
```
20
22
21
-
*`<IP_RANGE>`: The IP range in CIDR format (e.g., `192.168.1.0/24`, `10.0.0.0/8`).
23
+
-`<Command>`: Any command that uses IP generation
24
+
-[`generate`](/usage/commands/generate.md)
25
+
-[`crawl`](/usage/commands/crawl.md)
26
+
-`<IP_RANGE>`: The IP range in CIDR format (e.g., `192.168.1.0/24`, `10.0.0.0/8`).
22
27
23
28
## Examples
24
29
25
-
To generate random IPs exclusively within the `172.16.0.0/16` range:
30
+
To generate random IPs exclusively within the `1.1.1.0/16` range:
Specifies the path to a custom configuration file (e.g., `config.toml`). This allows users to manage settings such as database connections and crawler parameters separately from environment variables or default settings.
12
+
Specifies the path to custom configuration files for ServerRawler. This allows you to use your own configuration settings instead of the config/ folder in the root directory of your project. (Where you run ServerRawler from)
12
13
13
-
:::info
14
-
Using a dedicated configuration file is recommended for managing complex deployments or specific operational profiles.
14
+
:::warning[Important]
15
+
The path you specify with the `--config` argument is the directory where the folder `config` is located, not the path to the configuration files itself.
16
+
For example, if your configuration files are located in `path/to/your/custom_config_folder/config`, you should specify `--config path/to/your/custom_config_folder` as the argument.
15
17
:::
16
18
17
19
## Usage
18
20
19
21
```bash
20
-
ServerRawler --config <PATH_TO_CONFIG_FILE>
21
-
ServerRawler -c <PATH_TO_CONFIG_FILE>
22
+
ServerRawler --config <PATH_TO_CONFIG_FOLDER>
23
+
ServerRawler -c <PATH_TO_CONFIG_FOLDER>
22
24
```
23
25
24
-
*`<PATH_TO_CONFIG_FILE>`: The absolute or relative path to your `config.toml` file.
26
+
-`<PATH_TO_CONFIG_FOLDER>`: The absolute or relative path to your custom configuration folder.
27
+
25
28
26
29
## Examples
27
30
28
-
To run ServerRawler using a configuration file named `my_custom_config.toml` located in the current directory:
31
+
To run ServerRawler using a custom configuration folder located at `my_custom_config_folder` in the current directory:
29
32
30
33
```bash
31
-
ServerRawler --config my_custom_config.toml
34
+
./ServerRawler --config my_custom_config_folder
32
35
```
33
36
34
-
To run ServerRawler with a configuration file located at a specific absolute path:
37
+
To run ServerRawler with a configuration folder located at a specific absolute path:
0 commit comments