Self-hosted FAQ

Getting Started

Can I try the self-hosted version of pgDash to see if it meets my needs?

Yes. Please contact us at [email protected] for a 14-day Free Trial license. Be sure to mention the number of servers you want to monitor. You can find detailed technical instructions for getting started with the self-hosted version of pgDash here: https://docs.pgdash.io/self-hosted

The feature set of the on-premise version is same as what you see in the SaaS instance at app.pgdash.io, so you can also check out pgDash by signing up for the 14-day Free Trial of the SaaS version of pgDash.

How do I get started with self-hosted / on-premise pgDash?

You can find detailed technical instructions for getting started with the self-hosted version of pgDash here: https://docs.pgdash.io/self-hosted

Please note: the SaaS and self-hosted versions of pgDash are entirely separate, so please be sure to login to your instance only when setting up and using the self-hosted version. You will not be able to login via app.pgdash.io to access your self-hosted instance of pgDash.

What is the recommended hardware configuration for running the pgDash server?

The minimum hardware configuration depends on the number of Postgres databases you'll be monitoring. Please contact us as [email protected] and let us know:

Number of servers:

Number of Postgres clusters per server: 1

Number of databases per cluster (average):

Number of tables per database (average):

Number of indexes per database (average):

With these details, we can provide you a recommended minimum hardware configuration for your deployment.

What dependencies are there / what other software do I need to run my own pgDash server instance?

The pgDash server can run on Debian 9+, Ubuntu 18.04 LTS, Centos/RHEL 7+ and similar distros. It needs a PostgreSQL v10+ database to store non-timeseries data. We recommend creating a dedicated database and user on your PostgreSQL server for pgDash's use.

What features does the on-premise version have?

The feature set of the on-premise version is same as what you see in the SaaS instance at app.pgdash.io, so you can also check out pgDash by signing up for the 14-day Free Trial of the SaaS version of pgDash.

How much does it cost?

The self-hosted version of pgDash is priced similarly to the SaaS version, but is licensed on an annual rather than a monthly basis. License fees are payable, annually, in advance, and include a 10% discount off list prices.

Total price depends on the number of servers you want to monitor. For licensing purposes, a "server" is technically a Postgres cluster -- a single postgres server process (postmaster/daemon) managing a set of databases. Please write to us at [email protected] with this information and we'll get back with a quote.

What payment options do you accept for the self-hosted version of pgDash?

Annual license fees can be paid by credit card, wire transfer or ACH (US only).

Running pgDash

How do I get an API key on the on-premise version?

Signup at the signup page on your pgDash server (http://your-server:8080/signup). After you are logged in, you can copy the key from the profile page.

Note that the SaaS and self-hosted versions of pgDash are entirely separate, so please be sure to login to your instance only. You will not be able to login via app.pgdash.io to access your self-hosted instance of pgDash.

How do I send in the pgmetrics reports?

After logging in to your pgDash server, copy out the API key from the profile page. Use this key, along with the URL of your pgDash server, in the command line:

pgmetrics {args} | pgdash -a APIKEY --base-url=http://your-server:8080/api/v1 \
    report your-db-server-name

Note that the right API key and the "--base-url" parameter must be specified for this to work correctly. The base URL instructs the pgdash CLI command to send the data to your pgDash server and not the SaaS instance.

How do I share access with my team?

You can share access on a per-dbserver basis using the Team Sharing feature. See the Teams page for more information.

Note that you must configure an SMTP server in /etc/pgdash/pgdash.cfg so that your pgDash server is able to send invite mails for team sharing. More details here.

There are no queries listed in the "Queries" page.

Please see the Working With Queries page for information on how to collect query information from PostgreSQL.

Where does pgDash store it's data? How should I manage it?

• pgDash stores most of it's data in a PostgreSQL database that you'll have to provision and manage.

• Timeseries metrics and related data are stored on the local filesystem under /var/lib/pgdash. This directory maybe symlinked to another disk (NFS volumes are also OK). The pgDash daemon internally prunes out old timeseries data (by default data older than 3 months) automatically.

• Log files are present under /var/log/pgdash.

• Configuration and license files are present under /etc/pgdash .