đŗ Docker QuickStart
Let's discover PGMate in less than 5 minutes...
But if you really are in a rush, just click here and run it in GitPod.io:
You can easily run PGMate Demo Project in the Cloud for free, and quickly get to a result like:
Getting Startedâ
PGMate offers multiple ways to get started, tailored to your preferences:
Choose the option that works best for you and start exploring!
In the Cloudâ
Run PGMate on GitPod.ioâ
Click on this button and enjoy the automation:
Run PGMate on GitHub Codespaceâ
- Open the Demo Project on GitHub
- Click on: Code
- Click on: Create codespace on main
- Take a cup of coffee...
In Your Development Machineâ
Standalone Containerâ
This command will run the experimental standalone container that ships both PGMate and a Postgres 16 server within the same container:
docker run -p 8080:8080 pgmate/pgmate:latest-full
This is the minimal config option and works well in any OS that supports Docker.
Yes, also Windows.
Quick Bashâ
- open your favourite Terminal App
- paste this command
curl -sL https://bit.ly/3ZAx19E | bash -s -- run
You need Docker and a Linux environment (Mac also works fine)
Clone the Demo Projectâ
- open your favourite Terminal App
git clone https://github.com/pgmate/demo pgmate
cd pgmate
docker compose up
You need Docker and a Linux environment (Mac also works fine)
Loginâ
The Demo Project ships with pgmate
as default password:
You can change it to your favourite password by editing PGMATE_ADMIN_SECRET
env variable.
đ§âđģ If you are running if from the QuickBash command, try:
curl -sL https://bit.ly/3ZAx19E | bash -s \
-- run \
--secret=foobar
Connections Mangerâ
PGMate lets you define multiple connections:
PGMate requires a default connection string provided as environmental variable PGSTRING=postgres://postgres:xxx@postgres:5432/postgres
.
The Demo Project ships with a local Postgres container running alongside PGMate.
đ The default
connection is hidden in the Connections Manager and can not be modified via UI.
You can change the default db by editing the PGSTRING
env variable
đ§âđģ If you are running if from the QuickBash command, try:
curl -sL https://bit.ly/3ZAx19E | bash -s \
-- run \
--pgstring=postgres://....
All the connections that you add are stored in the default db and ARE ENCRYPTED WITH A DEFAULT KEY.
đģ This is ok for local instances, but it should always be seriously evaluated.
đŠī¸ If you are running PGMate in a shared instance, we recommend you to implement the PGMATE_ENCRYPTION_KEY
environmental variable with a custom encryption key that you can easily generate:
openssl rand -hex 32
Explore your Databaseâ
[[ coming soon... ]]
Move across different Viewsâ
[[ coming soon... ]]
Quick Connection Switchâ
[[ coming soon... ]]