Skip to main content

Installation

Narrowlink can be installed in the following ways:

Each component of Narrowlink has an individual binary and package name with specific functionalities:

  • narrowlink or narrowlink-client represents the Client component
  • narrowlink-agent represents the Agent component
  • narrowlink-gateway represents the Gateway component.
  • narrowlink-token-generator represents the Token Generator component.

Cargo​

Cargo is a package manager for the Rust programming language. It simplifies the process of managing Rust packages and their dependencies.

Prerequisite​

To install Narrowlink using Cargo, you must first install Cargo. On macOS, Linux, or another Unix-like system, you can run the following command in your terminal:

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

If you're using Windows, please refer to the "Other Installation Methods" section on the Rust website.

All Components​

cargo install narrowlink-gateway narrowlink-agent narrowlink-client narrowlink-token-generator

Updating​

To update Narrowlink, you can add --force to the end of the command to force Cargo to reinstall the package:

cargo install --force narrowlink-client narrowlink-agent narrowlink-gateway narrowlink-token-generator

or you can use (cargo-update) command to update all installed packages.

cargo install cargo-update
cargo install-update narrowlink-client narrowlink-agent narrowlink-gateway narrowlink-token-generator

Precompiled Binary​

If you prefer to use precompiled binaries, they are available on the GitHub release page. You can download the binaries from the links below that refer to the latest release. Currently, we provide binaries for Linux, macOS, and Windows platforms for both ARM and x86 architectures. However, it's worth noting that Narrowlink is not limited to these platforms - you can build for other targets using alternative installation methods.

Windows users

Windows security features may prevent you from running the downloaded binaries. If you encounter this issue, you can either disable the security features or build the binaries yourself. This issue happens because the binaries are not signed. We are working on signing the binaries to prevent this issue.

Gateway​

x64Arm64x86Arm32
LinuxDownloadDownloadDownloadDownload
MacOSDownloadDownloadN/AN/A
WindowsDownloadSoonDownloadN/A

Agent​

x64Arm64x86Arm32
LinuxDownloadDownloadDownloadDownload
MacOSDownloadDownloadN/AN/A
WindowsDownloadSoonDownloadN/A

Client​

x64Arm64x86Arm32
LinuxDownloadDownloadDownloadDownload
MacOSDownloadDownloadN/AN/A
WindowsDownloadSoonDownloadN/A

Token Generator​

x64Arm64x86Arm32
LinuxDownloadDownloadDownloadDownload
MacOSDownloadDownloadN/AN/A
WindowsDownloadSoonDownloadN/A

Source Code​

If you prefer to obtain pre-release versions of Narrowlink or modify the code before building, you can download the source code from Narrowlink's GitHub repository and build and install it yourself. This installation method requires the Git and Cargo commands to be installed on your system.