iamelevich / pocketbase-plugin-proxy

This plugin allow proxify requests to other host. It can be useful if you want to use separate server as frontend but use one address for both frontend and backend.

• Overview
  • Requirements
  • Installation
  • Example
• pocketbase_plugin_proxy
  • Index
  • func DefaultSkipper
  • type Options
  • type Plugin
    • func MustRegister
    • func Register
    • func (*Plugin) SetSkipper
    • func (*Plugin) Validate
• Contributing
  • Process
  • Development setup
  • Testing
  • Linting
  • Docs update in README

Overview

This plugin allow proxify requests to other host. It can be useful if you want to use separate server as frontend but use one address for both frontend and backend.

Requirements

• Go 1.18+
• Pocketbase 0.13+

Installation

go get github.com/iamelevich/pocketbase-plugin-proxy

Example

You can check examples in examples folder

package main

import (
	"log"

	proxyPlugin "github.com/iamelevich/pocketbase-plugin-proxy"
	"github.com/pocketbase/pocketbase"
)

func main() {
	app := pocketbase.New()

	// Setup proxy plugin
	proxyPlugin.MustRegister(app, &proxyPlugin.Options{
		Enabled: true,
		Url:     "http://localhost:3000",
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}

pocketbase_plugin_proxy

import "github.com/iamelevich/pocketbase-plugin-proxy"

Index

• func DefaultSkipper(c echo.Context) bool
• type Options
• type Plugin
  • func MustRegister(app core.App, options *Options) *Plugin
  • func Register(app core.App, options *Options) (*Plugin, error)
  • func (p *Plugin) SetSkipper(skipper middleware.Skipper)
  • func (p *Plugin) Validate() error

func DefaultSkipper

func DefaultSkipper(c echo.Context) bool

DefaultSkipper skip proxy middleware for requests, where path starts with /_/ or /api/.

type Options

Options defines optional struct to customize the default plugin behavior.

type Options struct {
    // Enabled defines if proxy should be enabled.
    Enabled bool

    //Url to the target.
    //
    //Only http and https links are supported.
    Url string

    // Are proxy logs enabled?
    ProxyLogsEnabled bool
}

type Plugin

type Plugin struct {
    // contains filtered or unexported fields
}

func MustRegister

func MustRegister(app core.App, options *Options) *Plugin

MustRegister is a helper function that registers plugin and panics if error occurred.

func Register

func Register(app core.App, options *Options) (*Plugin, error)

Register registers plugin.

func (*Plugin) SetSkipper

func (p *Plugin) SetSkipper(skipper middleware.Skipper)

SetSkipper set skipper function that should return true if that route shouldn't be proxied.

If not set, the DefaultSkipper is used:

If set - you should also control the middleware behavior for /_/ and /api/ routes.

Example:

plugin := proxyPlugin.MustRegister(app, &proxyPlugin.Options{
	Enabled: true,
	Url:     "http://localhost:3000",
})
plugin.SetSkipper(func(c echo.Context) bool {
	return c.Request().URL.Path == "/my-super-secret-route"
})

func (*Plugin) Validate

func (p *Plugin) Validate() error

Validate plugin options. Return error if some option is invalid.

Generated by gomarkdoc

Contributing

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.

Process

• Fork the repo
• Create a new branch
• Make your changes
• Create a pull request
• Wait for review
• Make changes if needed
• Merge
• Celebrate :)

Development setup

• 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 with pre-commit install -t commit-msg -t pre-commit

Testing

• Run make test to run tests
• Run make test-coverage to run tests with coverage report

Linting

• Run make lint to run linters

Docs update in README

• Install gomarkdoc
• Run make docs to update docs in README