Getting Started #

Install Tankman #

Download binaries for your platform from the Releases Page.

The following are supported:

  • linux x86-64
  • linux x86-64 musl
  • arm64 linux distros
  • macOS M1 (untested)
  • macOS x64 (untested)
  • Windows x86-64 (untested)

Configuring Tankman #

Step 1: Create a new database for tankman on your PostgreSQL server. Call it whatever you want, but most people call it tankmandb.

Step 2: Initialize the database. You can do that with the following command:

./tankman --initdb --dbhost YOUR_PG_HOST --dbport YOUR_PG_PORT --dbuser YOUR_PG_USER --dbpass YOUR_PG_PASSWORD

That’s it. You’re ready to roll.

Running Tankman #

The following command will start tankman on localhost:1989

./tankman --dbhost YOUR_PG_HOST --dbport YOUR_PG_PORT --dbuser YOUR_PG_USER --dbpass YOUR_PG_PASSWORD

You can change the hostname and port with the --host and --port CLI options.

./tankman --host --port 1990 --dbhost YOUR_PG_HOST --dbport YOUR_PG_PORT --dbuser YOUR_PG_USER --dbpass YOUR_PG_PASSWORD

Configuring via Environment Variables #

Instead of using CLI options as given above, you may use $TANKMAN_HOST (instead of --host), $TANKMAN_PORT (instead of --port) and $TANKMAN_CONN_STR (instead of --dbhost, --dbport, --dbuser, --dbpass) environment variables.

Like this:

TANKMAN_CONN_STR=Server=localhost;Port=5432;Database=tankmandb;User Id=postgres;Password=postgres

# run tankman!

Docker #

Alternatively you can pull our docker images. [Coming soon. Help wanted.]

⚠️ Caution #

Tankman is an internal service which should be accessible only from your backend apps. Make sure that you don’t expose Tankman ports publicly.