martin/README.md
2018-10-10 17:23:41 +03:00

1.9 KiB
Executable File

Martin

CircleCI

Martin is a PostGIS Mapbox Vector Tiles server written in Rust using Actix web framework.

Installation

You can download Martin from the Github releases page.

If you are running macOS and use Homebrew, you can install Martin using Homebrew tap.

brew tap urbica/tap
brew install martin

Usage

martin postgres://postgres@localhost/db

Environment variables

You can configure martin with environment variables

Environment variable Example Description
DATABASE_URL postgres://postgres@localhost/db postgres database connection
DATABASE_POOL_SIZE 20 maximum connections pool size
WORKER_PROCESSES 8 number of web server workers
KEEP_ALIVE 75 connection keep alive timeout

Using with Docker

You can use official Docker image urbica/martin

docker run \
  -p 3000:3000 \
  -e DATABASE_URL=postgres://postgres@localhost/db \
  urbica/martin

Building from source

You can clone repository and build Martin using cargo package manager.

git clone git@github.com:urbica/martin.git
cd martin
cargo build --release

The binary will be available at ./target/release/martin

./target/release/martin postgres://postgres@localhost/db

Development

Install project dependencies and check that all the tests run

cargo test
cargo run