The minimum required rust version now is 1.90.

It is recommended to always using the lastest stable rust version.

See rustup.rs to install rustup. It is recommended to use a non-root user.

cargo, rustc, rustup and other commands will be installed to Cargo's bin directory. The default path is $HOME/.cargo/bin, and the following examples will use this. You need to add this directory to your PATH environment variable.

• Bash

  The setup script should have already added the following line to your $HOME/.profile:

  source "$HOME/.cargo/env"

• Fish

  Run the following command:

  set -U fish_user_paths $HOME/.cargo/bin $fish_user_paths

rustup self update

List all available components:

rustup component list

The following components is required and should have already been installed:

• rustc
• rust-std
• cargo
• rustfmt
• clippy

It is recommended to install llvm-tools:

rustup component add llvm-tools

Install nightly toolchains:

rustup toolchain install nightly

List components in nightly channel:

rustup component list --toolchain nightly

Run the following command to update the toolchains for all channel:

rustup update

To install:

cargo install <crate name>

To update:

cargo install -f <crate name>

The following plugins is recommended:

• cargo-expand

  Needed by IDE to expand macros. The nightly toolchain is also required to run this.

• cargo-audit

  Audit Cargo.lock for crates with security vulnerabilities.

• cargo-binutils

  To run llvm-tools installed via rustup.

• cargo-cache

  To clean cargo caches.

• cargo-deny

  To check licenses of dependencies.

It is recommended to use Debian based distro as your development platform.

apt-get install gcc pkgconf make capnproto
apt-get install curl jq xz-utils tar
apt-get install libssl-dev libc-ares-dev
# install lua5.4 or any other versions available on your system
apt-get install lua5.4-dev
apt-get install libpython3-dev
apt-get install python3-toml python3-requests python3-pycurl python3-semver python3-socks python3-dnspython
apt-get install python3-maxminddb python3-location
apt-get install python3-sphinx python3-sphinx-rtd-theme
apt-get install lsb-release dpkg-dev debhelper

The devel packages is contained in repos that is not enabled by default, you need to check the files under /etc/yum.repo.d/ and enable the corresponding repos. See EPEL Quickstart for more info.

Some scripting or testing tools may be unavailable.

# enable epel repo first
dnf install epel-release
dnf update

#
dnf install gcc pkgconf make capnproto
dnf install curl jq xz tar
dnf install openssl-devel c-ares-devel lua-devel
dnf install python3-devel
dnf install python3-toml python3-requests python3-pycurl python3-semver
dnf install python3-maxminddb
dnf install python3-sphinx python3-sphinx_rtd_theme
dnf install rpmdevtools rpm-build

brew install pkgconf capnp
brew install openssl c-ares
brew install lua
# install python, or you can use the one provided by XCode
brew install python

# install rust toolchain
winget install Rustlang.Rust.MSVC
# install tools
winget install capnproto.capnproto
# option 1: vendored build
#  install tools for vendored build
winget install Kitware.CMake NASM.NASM Ninja-build.Ninja
# option 2: vcpkg
#  install static libraries via vcpkg
#  check [Triplets](https://learn.microsoft.com/en-us/vcpkg/users/platforms/windows) to select the correct *-static-md tripet
vcpkg install --triplet=x64-windows-static-md openssl c-ares
#  export the VCPKG_ROOT environment variable
$Env:VCPKG_ROOT = "some path to vcpkg"
#  build, lua and python feature need to be disabled
cargo build --no-default-features --features rustls-ring,quic,c-ares

Tips

• Install WinGET without Windows App Store:

  # Download the new release from https://github.com/microsoft/winget-cli/releases
  Add-AppxPackage -Path <xxx.msixbundle>

• Install a standalone version of vcpkg:

  git clone https://github.com/microsoft/vcpkg.git
  cd vcpkg
  .\bootstrap-vcpkg.bat
  # Then add the install path to `Path` and `VCPKG_ROOT` environment variable

pkg install rust
pkg install pkgconf capnproto
pkg install c-ares
# install lua5.4 or any other versions available on your system
pkg install lua54
pkg install python3

Tips

• Use the latest ports packages

  The default config in /etc/pkg/FreeBSD.conf is configured to use quarterly pkg builds, you can run the following commands to switch to use the latest pkg builds:

  mkdir -p /usr/local/etc/pkg/repos/
  echo 'FreeBSD: {url: "pkg+http://pkg.FreeBSD.org/${ABI}/latest"}' > /usr/local/etc/pkg/repos/FreeBSD.conf
  pkg update -f
  pkg upgrade -y

pkgin install rust
pkgin install pkgconf capnproto
pkgin install libcares
# install lua5.4 or any other versions available on your system
pkgin install lua54
# install python 3.12 or any other versions available on your system, and create links
pkgin install python312
ln -s /usr/pkg/bin/python3.12 /usr/pkg/bin/python3

Tips

• Use the latest pkgsrc packages

  The pkgsrc packages is available at https://cdn.netbsd.org/pub/pkgsrc/packages/NetBSD/, modify /usr/pkg/etc/pkgin/repositories.conf to use a latest version.

# install rust toolchain
pkg_add rust
# install capnproto
pkg_add capnproto
# install libs
pkg_add libcares
# install lua5.4 or any other versions available on your system
pkg_add lua
pkg_add python

Tips

• Increase process memory limit size

  The datasize-cur limit in /etc/login.conf for login class staff need to be increased if the compilation failed with error out of memory.

# install rust toolchain
pkg install rust
pkg install pkg-config
# install capnproto / c-ares from source

For g3proxy:

openssl >= 1.1.1
c-ares >= 1.13.0
lua
python3 >= 3.7

The tools for C development should be installed, including but not limited to:

gcc
pkg-config

If the c-ares version in the OS repo is too old, the following tools is also required:

cmake

We use capnproto rpc to communicate with the running daemon process:

capnproto

The following tools are needed to run testing scripts:

curl

The following tools are used in scripts under directory scripts/:

git
jq
tar
xz

We use python3 for more complicated scripts, the following packages are needed:

toml
requests
semver
PySocks
dnspython
maxminddb

We use sphinx to generate docs, with theme sphinx-rtd-theme.

For all Debian based distributions:

lsb-release
dpkg-dev
debhelper

For all RHEL based distributions:

rpmdevtools
rpm-build