Promscale from source

You can install Promscale from source on any operating system. The Promscale source files are available from our GitHub releases page.

Before you begin, you must have an already installed and working Prometheus environment. Additionally, you need a self-hosted TimescaleDB instance installed.

Install TimescaleDB

Installing TimescaleDB to use with Promscale requires the TimescaleDB database, as well as the Promscale extension. The Promscale extension contains support functions to improve performance of Promscale. While Promscale runs without it, it is strongly recommended that you install the Promscale extension.

Build and Install TimescaleDB

  1. Install TimescaleDB following the instructions in the TimescaleDB install page
  2. Compile and install the Promscale extension from source, it is available on the Promscale extension page

Install the Promscale pre-compiled binary

In this procedure, you download the Promscale binaries and run them.

Installing Promscale from source

  1. At the command prompt, as root, download the appropriate source files for your operating system (get the URL from the GitHub repository releases page):

    curl -L -o promscale https://github.com/timescale/promscale/releases/download/<VERSION>/<PROMSCALE_DISTRIBUTION>
  2. Grant executable permissions on the promscale directory:

    chmod +x promscale
  3. Run Promscale by providing the connection details for your TimescaleDB service:

    ./promscale --db-host <DB_HOSTNAME> --db-port <DB_PORT> --db-name <DBNAME> --db-password <DBPASSWORD> --db-ssl-mode allow

    note

    In this example, Promscale is deployed with SSL allowed but not required. If you need SSL mode enabled, configure your TimescaleDB instance with SSL certificates and do not use --db-ssl-mode flag. Promscale authenticates using SSL by default.

Found an issue on this page?

Report an issue!

Keywords

Related Content