Product Guides & Reference
Fast, practical answers for every PGBHub product. Choose a product area below or search by keyword.
Showing 62 guides across 12 topics
Authentication in your project: users, settings and the Playground
3 minWhat built-in authentication gives your app, and a tour of the Authentication page in the Console.
Choose sign-in methods and password rules
2 minTurn sign-in methods on or off, set password rules and session lifetimes, and decide whether email must be verified.
Email verification and password reset
2 minHow confirmation emails and password resets work, and how to wire the links into your app.
Customize the emails your users receive
2 minEdit the subject, wording, sender name and button colour of sign-in, verification and reset emails, with a live preview.
Send authentication emails from your own domain
2 minAdd and verify a sending domain so sign-in, verification and reset emails show your brand and address.
Add social login with Google or GitHub
2 minRegister your app with a provider, paste its credentials into the Console, and let people sign in with an account they already have.
Two-factor sign-in for your app's users
2 minHow your users can protect their accounts with an authenticator app, and how you test and reset it.
Ask for more at sign-up with profile fields
2 minCollect a username, name, user type or custom details at sign-up, checked on the server and saved with the user's profile.
Protect rows with row-level security
2 minUse RLS policies and the signed-in user's identity so each person sees only their own rows.
Daily snapshots and retention
1 minHow automatic daily backups work, how to set retention, time and snapshot count, and when they cost money.
Restore, download and import backups
1 minRestore a snapshot or uploaded dump into a database, download .sql.gz exports and use command-line dumps.
Project recovery points
1 minRestore a whole project, all databases and stored files together, to an earlier point, and what happens to current data.
Hourly backups and point-in-time recovery
1 minWhat the paid hourly backup option gives you, and what is and is not available for restoring to an exact moment.
Usage and the free allowance
1 minRead the Usage & Billing page: month-to-date cost, storage and compute meters, project breakdown and usage history.
Add funds to your wallet
1 minTop up your prepaid balance, turn on auto-reload and read the activity list.
Billing currencies
1 minUSD is the default; where a local currency such as the Nigerian naira is offered you choose it before your first payment.
PGB Credits
1 minWhat credits are, how they are spent and expire, and the application page.
Invoices, billing details and payment methods
1 minEdit invoice details, view statements and receipts, and see how monthly statements are settled.
When your balance runs low or empty
1 minThe warning states, the grace period, what a pause does and how to resume.
Deploy a container from code, GitHub or an image
3 minRun a backend service, web app or worker in your project, with a public address and your database already connected.
Scale to zero: how sleeping and waking works
3 minLet idle containers sleep at no compute cost, wake on the next request, or keep one always online.
Container environment variables, secrets and logs
2 minConfigure your container with variables and project secrets, and read build and runtime logs to fix problems.
Use your own domain on a container, with HTTPS
2 minPoint a subdomain at your container, check DNS, and get an HTTPS certificate automatically.
Create a database
2 minAdd a PostgreSQL database to a project, choose its version and extensions, and manage several databases in one project.
Connection strings, direct and pooled connections
3 minFind your host, port and credentials, choose between the pooled, regular and direct connection, and test that they work.
Your database's own address
2 minUse the per-database address shown on the Connection page, what is faster about it, and how to rename it safely.
The SQL editor
2 minRun queries and scripts against your database from the Console, use templates and history, and understand the safety limits.
Import data into a database
2 minBring a database over from another host, or upload a .sql or .sql.gz dump, from the Backups page.
Extensions
1 minSee which PostgreSQL extensions are available for your database, enable or disable them and understand "needs approval".
PostgreSQL versions and upgrades
1 minChoose a version when you create a database and upgrade to a newer one from DB Settings, with a verified copy.
Network access and IP allowlists
1 minRestrict which IP addresses may call your database's endpoints, and what is enforced where.
Query Advisor and performance
1 minRun a schema audit, analyze slow queries, apply suggested indexes and watch database metrics.
Limits, pausing and deleting a database
1 minThe limits your databases run with, what a pause means and how deleting a database works.
The REST API: query your data over HTTPS
2 minRead and write rows, run SQL and call actions with plain HTTP requests to your project address.
Use the TypeScript SDK
2 minInstall @pgb/sdk, create a client, run a first query, and find the calls for each service.
Use the Python SDK
1 minInstall pgbhub, create a sync or async client, run a first query, and use auth, mail, storage and actions.
Use the Go and Rust SDKs
2 minInstall the Go and Rust clients and run a first call with each, then find auth, mail, storage and actions.
Connect AI coding tools with the MCP server
2 minLet tools such as Claude Code, Cursor and Windsurf inspect your schema and run your actions through the PGB MCP server.
Webhooks: receiving and sending
2 minReceive webhooks in a function, send them from event rules, cron jobs, jobs and actions, and verify signatures.
API keys
1 minPublishable and secret project keys, account-level keys, how to create, scope, rotate and revoke them.
Create and deploy a function
3 minWrite a function in the Console editor, choose a runtime and trigger, test it, and call it over HTTP.
Function secrets, webhooks and logs
3 minKeep keys out of your code, protect a function with a signed webhook, and read or limit its execution logs.
Schedule work with Cron Jobs
2 minRun a function, SQL, an action, an HTTP call or an email on a schedule, and read the run history.
Background tasks (jobs) with automatic retries
2 minHand slow or unreliable work to a background job that retries on its own, and watch its status in the Console.
Actions: named transactions with effects
3 minDefine a named SQL transaction once, call it from your app, an AI agent or a schedule, and trigger emails, queues and more after it commits.
Send email from your app
3 minSend transactional email such as receipts and notifications with one API call, and check delivery in the Console.
Send email from your own domain
2 minVerify your domain with DNS records so your app's email comes from your brand and your own address.
Request approval to send email, and how limits work
2 minWhy sending needs a quick review, how to request access, and the limits and reputation checks that protect your sending.
Organizations and projects
2 minHow organizations (workspaces) and projects relate, how to switch between them and who pays for what.
Invite teammates and choose roles
2 minInvite people to your organization from IAM, pick a role and project scope, change access later and cancel invitations.
Project settings, keys, secrets and deleting a project
2 minWhat the Project Settings page shows, how to rename a project, where API keys and secrets live and how to delete a project safely.
Move a project to another organization
2 minHow a project is moved to a different organization, what moves with it, and what the new owner should do straight afterwards.
Protect your account with a strong password, two-step sign-in and session control
2 minChange your password, turn on two-step sign-in with recovery codes, sign out other sessions and revoke account API keys.
The PGBHub mobile app
2 minWhat you can check and do from the PGBHub app on your phone, and what stays on the web.
Realtime channels: broadcast and subscribe
2 minPush live updates to browsers and apps over named channels, and test them from the Console.
Queues and background workers
2 minCreate a queue, push messages, process them with workers, and use retries and the dead-letter queue.
Event rules: react when something happens
2 minRoute events such as user.created to a queue, function, webhook or email, and test rules with a sample event.
Create buckets and upload files
2 minCreate a storage bucket, organise it with folders, upload files from the Console and copy their links.
Private buckets and signed links
3 minKeep files private, share one file for a limited time with a signed link, and switch a bucket between public and private.
Upload and list files from your app
2 minUse the SDK or the storage endpoints to upload, list, download and delete files from your own code.