VersaTiles Installation Guide

This guide outlines different ways to install VersaTiles on your system:

• Using Homebrew (macOS)
• Using the Install Script (Linux / macOS)
• Using PowerShell (Windows)
• NixOS
• Building with Cargo
• Building from Source

TIP

If you want to setup your own map server, use our "Setup Tool" to generate the necessary shell code: versatiles.org/tools/setup_server

Using Homebrew (macOS)

To install VersaTiles using Homebrew, run the following commands in your terminal:

brew tap versatiles-org/versatiles
brew trust versatiles-org/versatiles
brew install versatiles

To upgrade to the latest version, use:

brew update
brew upgrade versatiles

Using the Install Script (Linux / macOS)

You can use the install script to download and install the appropriate precompiled binary for your system. The script automatically places the binary in /usr/local/bin/.

Run the following command:

curl -Ls "https://github.com/versatiles-org/versatiles-rs/releases/latest/download/install-unix.sh" | sudo sh

Using PowerShell (Windows)

Open PowerShell and run:

irm "https://github.com/versatiles-org/versatiles-rs/releases/latest/download/install-windows.ps1" | iex

This downloads and installs the latest precompiled Windows binary.

NixOS

VersaTiles is available in Nixpkgs. Search for it in the NixOS package index or install directly:

nix-env -iA nixpkgs.versatiles

Building with Cargo

Ensure that you have Rust and Cargo installed. Then, install VersaTiles with:

cargo install versatiles

Building from Source

To manually build VersaTiles from the source code, follow these steps:

git clone https://github.com/versatiles-org/versatiles-rs.git
cd versatiles-rs
cargo build --bin versatiles --release
cp ./target/release/versatiles /usr/local/bin/

Additional Information

For Docker-based installation and further details, refer to the Installation section of the VersaTiles repository.