https://github.com/mohammed90/caddy-pocketbase
PocketBase embedded in Caddy
https://github.com/mohammed90/caddy-pocketbase
baas caddy caddy-plugin caddyserver pocketbase
Last synced: 3 months ago
JSON representation
PocketBase embedded in Caddy
- Host: GitHub
- URL: https://github.com/mohammed90/caddy-pocketbase
- Owner: mohammed90
- License: apache-2.0
- Created: 2024-11-26T11:29:22.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-21T18:44:15.000Z (7 months ago)
- Last Synced: 2025-06-28T17:03:12.977Z (3 months ago)
- Topics: baas, caddy, caddy-plugin, caddyserver, pocketbase
- Language: Go
- Homepage:
- Size: 59.6 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Caddy PocketBase Module
A Caddy module that integrates [PocketBase](https://pocketbase.io/)([Repository](https://github.com/pocketbase/pocketbase)) as a Caddy application, allowing you to run PocketBase embedded in your Caddy server.
## Features
- Run PocketBase as a native Caddy module
- Admin API endpoints for managing superusers
- Configurable data directory and origins
- Automatic port allocation if none specified
- Full integration with Caddy's configuration and lifecycle
## Configuration
Example Caddyfile configuration:
```caddyfile
{
order pocketbase before file_server
}
example.com {
pocketbase
}
```
The embedded pocketbase app can be customized (with limitations) as follows:
```caddyfile
{
pocketbase {
# optional: port pocketbase will listen to; defaults to randomly allocated port.
listen 8080
# optional: default data directory; defaults to ./pb_data.
data_dir /var/pb
# optional: all origins allowed when empty; defaults to all origins.
origins example.com example.net localhost
}
order pocketbase before file_server
}
example.com {
pocketbase
}
```
## Key Components
- **PocketBase Integration**: Runs PocketBase within Caddy.
- **Admin API**: Provides endpoints for superuser management.
- **Configuration**: Allows customization of data directory and origins.
## Usage
This module enables you to run PocketBase as part of your Caddy server, simplifying deployment and management of both services. The configuration options allow for easy customization to fit various deployment scenarios.
## Admin API Endpoints
The module provides admin API endpoints under `/pocketbase/`:
- `POST /pocketbase/superuser` - Create a new superuser
- `PUT /pocketbase/superuser` - Upsert a superuser
- `PATCH /pocketbase/superuser` - Update superuser password
- `DELETE /pocketbase/superuser` - Delete a superuser
- `POST /pocketbase/superuser/{email}/otp` - Generate OTP for superuser
All the above endpoints require a JSON payload, except for the OTP endpoint. The
JSON payload for the superuser endpoints is as follows:
```json
{
"email_address": "...",
"password": "..."
}
```
The `DELETE` endpoint does not expect the `password` field.