Getting started

Requirements

Via requires Crystal 1.21.1 or newer. A normal build also needs the OpenSSL development libraries used by Crystal's HTTPS client.

Fedora:

sudo dnf install openssl-devel

Debian or Ubuntu:

sudo apt install libssl-dev pkg-config

Verify the toolchain:

make doctor

Build

make release

The binary is written to bin/via.

For an HTTP-only binary on a machine without OpenSSL development libraries:

make release-http

Create a configuration

Save the following as via.yaml:

listen: ":8080"
proxy_pass: http://localhost:3000

Run Via

via -c via.yaml

Requests to http://localhost:8080 are now proxied to http://localhost:3000.

The CLI also exposes:

via --debug -c via.yaml
via --help
via --version

Continue with Configuration and routing to configure multiple upstreams.