1
0
mirror of https://github.com/pocketbase/pocketbase.git synced 2024-11-25 01:16:21 +02:00
Open Source realtime backend in 1 file https://pocketbase.io/
Go to file
2023-07-14 12:16:56 +03:00
.github [#2231] revert the aws-sdk-go-v2 change 2023-04-06 20:17:22 +03:00
apis updated tests with some clarification code comments 2023-07-14 12:13:44 +03:00
cmd removed the legacy temp upgrade command 2023-05-17 18:39:15 +03:00
core updated nocgo busy_timeout pragma 2023-05-27 09:37:21 +03:00
daos [#2570] use ON for consistency with the SQLite examples and updated collection delete test to check for _exterAuths references 2023-05-25 20:26:03 +03:00
examples/base added experimental update command 2023-05-17 21:14:12 +03:00
forms [#2868] fixed unique validator detailed error message not being returned when camelCase field name is used 2023-07-06 23:14:18 +03:00
mails removed unnecessary mail layou css class 2023-03-19 10:16:23 +02:00
migrations [#2570] fixed default PRAGMAs not being applied for new connections 2023-05-27 09:04:01 +03:00
models optimized search count queries to use rowid by default 2023-07-03 17:57:23 +03:00
plugins replaced multiple error wraps with plain %v for older go 1.18 and go 1.19 compatibility 2023-05-29 17:01:04 +03:00
resolvers revert part of the old COALESCE handling to support missing joined relation fields comparison with empty string 2023-04-03 20:27:52 +03:00
tests registered custom cgo sqlite driver 2023-05-27 09:24:18 +03:00
tokens [#215] added server-side handlers for serving private files 2023-04-04 20:33:35 +03:00
tools allow no space between the index table name and columns list 2023-07-06 23:20:31 +03:00
ui updated ui/dist 2023-07-14 12:01:48 +03:00
.gitignore tweaked automigrate to check for git status and extracted the base flags from the plugins 2022-11-26 22:33:27 +02:00
.goreleaser.yaml added linux cgo target 2023-03-27 21:39:46 +03:00
CHANGELOG.md updated changelog 2023-07-14 12:16:56 +03:00
CONTRIBUTING.md [#872] changed the schema required validator to be optional for auth collections 2022-11-16 15:13:04 +02:00
go.mod updated go deps 2023-07-08 20:06:34 +03:00
go.sum updated go deps 2023-07-08 20:06:34 +03:00
golangci.yml updated linter 2022-12-16 17:06:03 +02:00
LICENSE.md filter enhancements 2023-01-07 22:27:11 +02:00
Makefile initial v0.8 pre-release 2022-10-30 10:28:14 +02:00
pocketbase_test.go [#1267] call app.Bootstrap() before cobra commands execution 2022-12-15 23:20:23 +02:00
pocketbase.go removed the legacy temp upgrade command 2023-05-17 18:39:15 +03:00
README.md [#1240] added dedicated before/after auth hooks and refactored the submit interceptors 2023-01-15 17:00:28 +02:00

PocketBase - open source backend in 1 file

build Latest releases Go package documentation

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.

⚠️ Please keep in mind that PocketBase is still under active development and therefore full backward compatibility is not guaranteed before reaching v1.0.0.

API SDK clients

The easiest way to interact with the API is to use one of the official SDK clients:

Overview

PocketBase could be downloaded directly as a standalone app or it could be used as a Go framework/toolkit which allows you to build your own custom app specific business logic and still have a single portable executable at the end.

Installation

# go 1.18+
go get github.com/pocketbase/pocketbase

For Windows, you may have to use go 1.19+ due to an incorrect js mime type in the Windows Registry (see issue#6).

Example

package main

import (
    "log"
    "net/http"

    "github.com/labstack/echo/v5"
    "github.com/pocketbase/pocketbase"
    "github.com/pocketbase/pocketbase/apis"
    "github.com/pocketbase/pocketbase/core"
)

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

    app.OnBeforeServe().Add(func(e *core.ServeEvent) error {
        // add new "GET /hello" route to the app router (echo)
        e.Router.AddRoute(echo.Route{
            Method: http.MethodGet,
            Path:   "/hello",
            Handler: func(c echo.Context) error {
                return c.String(200, "Hello world!")
            },
            Middlewares: []echo.MiddlewareFunc{
                apis.ActivityLogger(app),
            },
        })

        return nil
    })

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

Running and building

Running/building the application is the same as for any other Go program, aka. just go run and go build.

PocketBase embeds SQLite, but doesn't require CGO.

If CGO is enabled (aka. CGO_ENABLED=1), it will use mattn/go-sqlite3 driver, otherwise - modernc.org/sqlite. Enable CGO only if you really need to squeeze the read/write query performance at the expense of complicating cross compilation.

To build the minimal standalone executable, like the prebuilt ones in the releases page, you can simply run go build inside the examples/base directory:

  1. Install Go 1.18+ (if you haven't already)
  2. Clone/download the repo
  3. Navigate to examples/base
  4. Run GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build (https://go.dev/doc/install/source#environment)
  5. Start the created executable by running ./base serve.

The supported build targets by the non-cgo driver at the moment are:

darwin  amd64
darwin  arm64
freebsd amd64
freebsd arm64
linux   386
linux   amd64
linux   arm
linux   arm64
linux   ppc64le
linux   riscv64
windows amd64
windows arm64

Testing

PocketBase comes with mixed bag of unit and integration tests. To run them, use the default go test command:

go test ./...

Check also the Testing guide to learn how to write your own custom application tests.

Security

If you discover a security vulnerability within PocketBase, please send an e-mail to support at pocketbase.io.

All reports will be promptly addressed, and you'll be credited accordingly.

Contributing

PocketBase 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.

You could help continuing its development by:

PRs for small features (eg. adding new OAuth2 providers), bug and documentation fixes, etc. are more than welcome.

But please refrain creating PRs for big features without previously discussing the implementation details. Reviewing big PRs often requires a lot of time and tedious back-and-forth communication. PocketBase has a roadmap and I try to work on issues in a specific order and such PRs often come in out of nowhere and skew all initial planning.

Don't get upset if I close your PR, even if it is well executed and tested. This doesn't mean that it will never be merged. Later we can always refer to it and/or take pieces of your implementation when the time comes to work on the issue (don't worry you'll be credited in the release notes).

Please also note that PocketBase was initially created to serve as a new backend for my other open source project - Presentator (see #183), so all feature requests will be first aligned with what we need for Presentator v3.