Documentation Index
Fetch the complete documentation index at: https://docs.nearbase.dev/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Creating a Nearbase instance takes 2–5 minutes. You’ll select a region, PostgreSQL version, instance class, and storage size — then complete checkout. Once provisioned, you receive a connection string and your database is immediately ready.Steps
Open the Console
Go to console.nearbase.dev and navigate to
Instances in the sidebar. Click New Instance.
Choose a Region
Select the region closest to your application servers or end users for the
lowest latency. See Regions for the full list and compliance
information.
Select a PostgreSQL Version
Choose the PostgreSQL major version. We recommend using the latest available
version unless you have a compatibility requirement.
Choose an Instance Class
Select the CPU and memory configuration that fits your workload. See
Instance Classes for a breakdown of all
available tiers and how to choose between them.
Set Storage Size
Choose the initial storage size in GB. Storage is backed by high-performance
cloud disk (
general_essd) by default.You can scale storage up later without downtime, but you cannot reduce it.
Start with enough room for your data plus anticipated growth.
Review and Checkout
Review the monthly price, then proceed to checkout. Payment is deducted from
your account balance first. If your balance
is insufficient, the remainder is charged to your saved card.Your instance enters Provisioning status and is typically ready within
2–5 minutes. You’ll see it switch to Running in the console.
After Provisioning
Once your instance is Running:- The Overview tab shows your full connection string.
- Connect with any PostgreSQL client — see Connecting to Your Database.
- Your IP address needs to be in the allowlist to connect. By default, all IPs (
0.0.0.0/0) are allowed. Restrict this in the Security tab.