Installation

ServerRawler offers two primary installation methods: downloading pre-compiled binaries for immediate use or building from source for developers.

Download Binaries (Recommended)

Method 1: Download Pre-compiled Binaries (Recommended)

The easiest way to get started with ServerRawler is to download a pre-compiled executable for your operating system from the GitHub Releases page. This method does not require you to have Rust installed.

Linux

1. Go to GitHub Releases: Visit the ServerRawler Releases page.
2. Download the latest release: Find the latest stable release and download the Linux executable (e.g. serverrawler-linux-amd64).
3. Make it executable: After downloading, we must unzip the archive and make the file executable.

tar -xzf serverrawler-linux-amd64.tar.gz
chmod +x ServerRawler

4. Create directory (optional): You can create a new directory for ServerRawler to keep things organized:

# Create directory
mkdir serverrawler_workspace
# Move the downloaded executable into the directory
mv ServerRawler serverrawler_workspace/
# Go into the directory
cd serverrawler_workspace

5. Test: Now, you can test the executable by running it in your terminal or command prompt:

./ServerRawler --help

Windows

1. Go to GitHub Releases: Visit the ServerRawler Releases page.
2. Download the latest release: Find the latest stable release and download the Windows executable (e.g., serverrawler-windows-amd64.exe).
3. Unzip: After downloading, we must unzip the archive.

tar -xzf serverrawler-windows-amd64.tar.gz

4. Create directory (optional): You can create a new directory for ServerRawler to keep things organized:

# Create directory
mkdir serverrawler_workspace
# Move the downloaded executable into the directory
mv ServerRawler serverrawler_workspace/
# Go into the directory
cd serverrawler_workspace

5. Test: Now, you can test the executable by running it in your terminal or command prompt:

./ServerRawler.exe --help

macOS

1. Go to GitHub Releases: Visit the ServerRawler Releases page.
2. Download the latest release: Find the latest stable release and download the macOS executable (e.g. serverrawler-macos-amd64).
3. Make it executable: After downloading, we must unzip the archive and make the file executable.

tar -xzf serverrawler-linux-amd64.tar.gz
chmod +x ServerRawler

4. Create directory (optional): You can create a new directory for ServerRawler to keep things organized:

# Create directory
mkdir serverrawler_workspace
# Move the downloaded executable into the directory
mv ServerRawler serverrawler_workspace/
# Go into the directory
cd serverrawler_workspace

5. Test: Now, you can test the executable by running it in your terminal or command prompt:

./ServerRawler --help

Build from Source

Method 2: Build from Source

If you wish to contribute to ServerRawler, modify its code, or prefer building from source, you'll need the Rust toolchain installed.

1. Install Rust

If you don't have Rust installed, than is here an example of installing it using rustup:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

For more information and alternative installation methods, refer to the official Rust installation guide.

2. Clone the Repository

Clone the ServerRawler repository from GitHub to your local machine:

git clone https://github.com/Cyberdolfi/ServerRawler.git
cd ServerRawler

3. Build the Project

Build the project in release mode for the best performance. This command will compile the source code and create the executable.

info

Building from source can take a few minutes, especially on the first run, as it needs to compile all dependencies.

cargo build --release

The executable will be available at target/release/.

Next Steps: Configuration and Database Setup

The next step is to set up your database connection. If you prefer to run ServerRawler without a database, you can skip the database setup and use the --no-database argument.

• Database Setup: ServerRawler requires a PostgreSQL database to store collected server data.
• Configuration Guide: Learn how to set up the configurations files and prepare your PostgreSQL database.