View Categories

Build Instructions (Linux)

The following instructions guide you through building the aralez executable for Linux.

Building #

Important: For compatibility with Legacy versions of Linux, it is important to build Aralez with the targets i686-unknown-linux-musl and x86_64-unknown-linux-musl.

1. Install Rust #
  • Ensure the Rust programming language toolchain is installed on your system. Rust can be installed by following the official guide at rust-lang.org.
  • You may confirm the installation by running:
rustc --version
  • Version Requirement: If targeting legacy versions of Linux add specific targets. This can be done with the following command:
rustup target add i686-unknown-linux-musl 
rustup target add x86_64-unknown-linux-musl
2. Clone the Aralez Repository #
  • Open a terminal or command prompt and navigate to the directory where you want to clone the repository.
  • Run the following commands to clone the Aralez repository and enter its directory:
git clone https://github.com/abaghinyan/aralez.git
cd aralez
3. Configure Aralez #
  • Create a configuration file named config.yml in the config directory.
  • Use the config_linux.yml.template file in the repository as a reference. Copy this template to config.yml and modify any necessary settings to match your requirements:
cp config/config_linux.yml.template config/config.yml
  • Open config.yml in a text editor to adjust the configuration as needed, such as specifying paths and options for data collection. For more information about the configuration, please refer to the Configuration section.
4. Build the Project #
  • Once your environment and configurations are ready, initiate the build process using Cargo, Rust’s package manager and build system.
  • To create a release build optimized for performance, run:
cargo build --release --target i686-unknown-linux-musl 
cargo build --release --target x86_64-unknown-linux-musl

Note: This command compiles Aralez in « release » mode, which optimizes the binary for reduced size and faster execution.

5. Locate the Executable #
  • After a successful build, the aralez executable will be located in the target/i686-unknown-linux-musl/release or target/x86_64-unknown-linux-musl/release directories. You can find it using:
cd target/i686-unknown-linux-musl/release
# or
cd target/x86_64-unknown-linux-musl/release