PocketBase
Generated on 21 Apr 2025 from the PocketBase catalog page
PocketBase is an open-source Go backend, consisting of:
- embedded database (SQLite) with realtime subscriptions
- built-in files and users management
- convenient Admin dashboard UI
- and simple REST-ish API
For documentation and examples, please visit https://pocketbase.io/docs.
Software Included
Package | Version | License |
---|
Creating an App using the Control Panel
Click the Deploy to DigitalOcean button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.
Creating an App using the API
In addition to creating a Droplet from the PocketBase 1-Click App using the control panel, you can also use the DigitalOcean API. As an example, to create a 4GB PocketBase Droplet in the SFO2 region, you can use the following curl
command. You need to either save your API access token) to an environment variable or substitute it in the command below.
curl -X POST -H 'Content-Type: application/json' \
-H 'Authorization: Bearer '$TOKEN'' -d \
'{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image": "doteamaccount-pocketbase"}' \
"https://api.digitalocean.com/v2/droplets"
Getting Started After Deploying PocketBase
Welcome to the PocketBase DigitalOcean 1-Click!
Please allow up to 3 minutes for all services to become available after installing this 1-click.
The one-click includes a fully installed and running PocketBase instance. The first time you access the system, you should use the following URL to set your admin password:
This installation of PocketBase uses a reverse proxy from Caddy to PB,
and is managed with systemctl:
systemctl restart pocketbase # Restart PocketBase
systemctl stop pocketbase # Stop the PocketBase server
systemctl start pocketbase # Start the PocketBase server
To add a custom domain, update the reverse proxy here:
/etc/caddy/Caddyfile
Getting Help:
Note- this one click is not maintained by the creator of PocketBase. To get help with using the software, use the PocketBase repo. For help with the one-click itself or to suggest improvements, use the link to the Packer build script.
PocketBase on GitHub: https://github.com/pocketbase/pocketbase
PocketBase Support: https://github.com/pocketbase/pocketbase/discussions
PocketBase Packer Script: https://github.com/scott/pocketbase-do-packer
Enabling SSL
To enable SSL, you will need to configure Caddy to configure a domain that reverse proxies to the PocketBase service. For more information, check the Caddy Docs: https://caddyserver.com/docs/quick-starts/https
You will find the Caddyfile here:
/etc/caddy/Caddyfile
.