This plugin allow expose local Pocketbase with ngrok
This plugin can be used for development purposes, when you need to expose your local Pocketbase instance to the internet. For example, you can use it to test your Pocketbase app on mobile device.
- Go 1.18+
- Pocketbase 0.13+
go get github.com/iamelevich/pocketbase-plugin-ngrok
You can check examples in examples folder
package main
import (
"context"
ngrokPlugin "github.com/iamelevich/pocketbase-plugin-ngrok"
"log"
"github.com/pocketbase/pocketbase"
)
func main() {
app := pocketbase.New()
// Setup ngrok
ngrokPlugin.MustRegister(app, &ngrokPlugin.Options{
Ctx: context.Background(),
Enabled: true,
AuthToken: "YOUR_NGROK_AUTH_TOKEN", // Better to use ENV variable for that
})
if err := app.Start(); err != nil {
log.Fatal(err)
}
}
import "github.com/iamelevich/pocketbase-plugin-ngrok"
Options defines optional struct to customize the default plugin behavior.
type Options struct {
// Ctx is a context that will be used to start ngrok tunnel.
Ctx context.Context
// Enabled defines if ngrok tunnel should be started.
Enabled bool
// AuthToken is your ngrok auth token. You can get it from https://dashboard.ngrok.com/auth
AuthToken string
// AfterSetup is a callback function that will be called after ngrok tunnel is started.
AfterSetup func(url string) error
}
type Plugin struct {
// contains filtered or unexported fields
}
func MustRegister(app core.App, options *Options) *Plugin
MustRegister is a helper function that registers plugin and panics if error occurred.
func Register(app core.App, options *Options) (*Plugin, error)
Register registers plugin.
func (p *Plugin) Validate() error
Validate plugin options. Return error if some option is invalid.
Generated by gomarkdoc
This pocketbase plugin is free and open source project licensed under the MIT License. You are free to do whatever you want with it, even offering it as a paid service.
- Fork the repo
- Create a new branch
- Make your changes
- Create a pull request
- Wait for review
- Make changes if needed
- Merge
- Celebrate :)
- Install asdf and plugins for tools listed in .tool-versions file.
- This repo also uses asdf-direnv. Install it and run
direnv allow
in the repo root. - Setup
pre-commit
hooks withpre-commit install -t commit-msg -t pre-commit
- Run
make test
to run tests - Run
make test-coverage
to run tests with coverage report
- Run
make lint
to run linters
- Install gomarkdoc
- Run
make docs
to update docs in README