-
Improved files delete performance when using the local filesystem by adding a trailing slash to the
DeletePrefix
call to ensure that the list iterator will start "walking" from the prefix directory and not from its parent (#5246). -
Updated Go deps.
-
Updated the
editor
field to use the latest TinyMCE 6.8.4 and enabledconvert_unsafe_embeds:true
by default per the security advisories. The Admin UI shouldn't be affected by the older TinyMCE because we don't use directly the vulnerable options/plugins and we have a default CSP, but it is recommended to update even just for silencing the CI/CD warnings. -
Disabled mouse selection when changing the sidebar width. This should also fix the reported Firefox issue when the sidebar width "resets" on mouse release out of the page window.
-
Other minor improvements (updated the logs delete check and tests, normalized internal errors formatting, updated Go deps, etc.)
- Fixed the days calculation for triggering old logs deletion (#5179; thanks @nehmeroumani). Note that the previous versions correctly delete only the logs older than the configured setting but due to the typo the delete query is invoked unnecessary on each logs batch write.
-
Added mutex to
tests.TestMailer()
to minimize tests data race warnings (#5157). -
Updated goja and the other Go dependencies.
-
Bumped the min Go version in the GitHub release action to Go 1.22.5 since it comes with
net/http
security fixes.
-
Added OAuth2 POST redirect support (in case of
response_mode=form_post
) to allow specifying scopes for the Apple OAuth2 integration.Note 1: If you are using the "Manual code exchange" flow with Apple (aka.
authWithOAuth2Code()
), you need to either update your custom redirect handler to accept POST requests OR if you want to keep the old behavior and don't need the Apple user's email - replace in the Apple authorization urlresponse_mode=form_post
back toresponse_mode=query
.Note 2: Existing users that have already logged in with Apple may need to revoke their access in order to see the email sharing options as shown in this screenshot. If you want to force the new consent screen you could register a new Apple OAuth2 app.
-
⚠️ Fixed a security vulnerability related to the OAuth2 email autolinking (thanks to @dalurness for reporting it).Just to be safe I've also published a GitHub security advisory (may take some time to show up in the related security databases).
In order to be exploited you must have both OAuth2 and Password auth methods enabled.
A possible attack scenario could be:
- a malicious actor register with the targeted user's email (it is unverified)
- at some later point in time the targeted user stumble on your app and decides to sign-up with OAuth2 (this step could be also initiated by the attacker by sending an invite email to the targeted user)
- on successful OAuth2 auth we search for an existing PocketBase user matching with the OAuth2 user's email and associate them
- because we haven't changed the password of the existing PocketBase user during the linking, the malicious actor has access to the targeted user account and will be able to login with the initially created email/password
To prevent this for happening we now reset the password for this specific case if the previously created user wasn't verified (an exception to this is if the linking is explicit/manual, aka. when you send
Authorization:TOKEN
with the OAuth2 auth call).Additionally to warn users we now send an email alert in case the user has logged in with password but has at least one OAuth2 account linked. It looks something like:
Hello, Just to let you know that someone has logged in to your Acme account using a password while you already have OAuth2 GitLab auth linked. If you have recently signed in with a password, you may disregard this email. If you don't recognize the above action, you should immediately change your Acme account password. Thanks, Acme team
The flow will be further improved with the ongoing refactoring and we will start sending emails for "unrecognized device" logins (OTP and MFA is already implemented and will be available with the next v0.23.0 release in the near future).
-
Fixed rules inconsistency for text literals when inside parenthesis (#5017).
-
Updated Go deps.
-
Fixed calendar picker grid layout misalignment on Firefox (#4865).
-
Updated Go deps and bumped the min Go version in the GitHub release action to Go 1.22.3 since it comes with some minor security fixes.
- Load the full record in the relation picker edit panel (#4857).
-
Updated the uploaded filename normalization to take double extensions in consideration (#4824)
-
Added Collection models cache to help speed up the common List and View requests execution with ~25%. This was extracted from the ongoing work on #4355 and there are many other small optimizations already implemented but they will have to wait for the refactoring to be finalized.
- Fixed Admin UI OAuth2 "Clear all fields" btn action to properly unset all form fields (#4737).
-
Fixed '~' auto wildcard wrapping when the param has escaped
%
character (#4704). -
Other minor UI improvements (added
aria-expanded=true/false
to the dropdown triggers, added contrasting border around the default mail template btn style, etc.). -
Updated Go deps and bumped the min Go version in the GitHub release action to Go 1.22.2 since it comes with some
net/http
security and bug fixes.
-
Replaced the default
s3blob
driver with a trimmed vendored version to reduce the binary size with ~10MB. It can be further reduced with another ~10MB once we replace entirely theaws-sdk-go-v2
dependency but I stumbled on some edge cases related to the headers signing and for now is on hold. -
Other minor improvements (updated GitLab OAuth2 provider logo #4650, normalized error messages, updated npm dependencies, etc.)
- Admin UI accessibility improvements:
- Fixed the dropdowns tab/enter/space keyboard navigation (#4607).
- Added
role
,aria-label
,aria-hidden
attributes to some of the elements in attempt to better assist screen readers.
-
Minor test helpers fixes (#4600):
- Call the
OnTerminate
hook onTestApp.Cleanup()
. - Automatically run the DB migrations on initializing the test app with
tests.NewTestApp()
.
- Call the
-
Added more elaborate warning message when restoring a backup explaining how the operation works.
-
Skip irregular files (symbolic links, sockets, etc.) when restoring a backup zip from the Admin UI or calling
archive.Extract(src, dst)
because they come with too many edge cases and ambiguities.More details
This was initially reported as security issue (thanks Harvey Spec) but in the PocketBase context it is not something that can be exploited without an admin intervention and since the general expectations are that the PocketBase admins can do anything and they are the one who manage their server, this should be treated with the same diligence when using
scp
/rsync
/rclone
/etc. with untrusted file sources.It is not possible (or at least I'm not aware how to do that easily) to perform virus/malicious content scanning on the uploaded backup archive files and some caution is always required when using the Admin UI or running shell commands, hence the backup-restore warning text.
Or in other words, if someone sends you a file and tell you to upload it to your server (either as backup zip or manually via scp) obviously you shouldn't do that unless you really trust them.
PocketBase is like any other regular application that you run on your server and there is no builtin "sandbox" for what the PocketBase process can execute. This is left to the developers to restrict on application or OS level depending on their needs. If you are self-hosting PocketBase you usually don't have to do that, but if you are offering PocketBase as a service and allow strangers to run their own PocketBase instances on your server then you'll need to implement the isolation mechanisms on your own.
-
Removed conflicting styles causing the detailed codeblock log data preview to not visualize properly (#4505).
-
Minor JSVM improvements:
- Added
$filesystem.fileFromUrl(url, optSecTimeout)
helper. - Implemented the
FormData
interface and added support for sendingmultipart/form-data
requests with$http.send()
(#4544).
- Added
-
Fixed the z-index of the current admin dropdown on Safari (#4492).
-
Fixed
OnAfterApiError
debug lognil
error reference (#4498). -
Added the field name as part of the
@request.data.someRelField.*
join to handle the case when a collection has 2 or more relation fields pointing to the same place (#4500). -
Updated Go deps and bumped the min Go version in the GitHub release action to Go 1.22.1 since it comes with some security fixes.
- Fixed a small regression introduced with v0.22.0 that was causing some missing unknown fields to always return an error instead of applying the specific
nullifyMisingField
resolver option to the query.
-
Fixed Admin UI record and collection panels not reinitializing properly on browser back/forward navigation (#4462).
-
Initialize
RecordAuthWithOAuth2Event.IsNewRecord
for theOnRecordBeforeAuthWithOAuth2Request
hook (#4437). -
Added error checks to the autogenerated Go migrations (#4448).
-
Added Planning Center OAuth2 provider (#4393; thanks @alxjsn).
-
Admin UI improvements:
- Autosync collection changes across multiple open browser tabs.
- Fixed vertical image popup preview scrolling.
- Added options to export a subset of collections.
- Added option to import a subset of collections without deleting the others (#3403).
-
Added support for back/indirect relation
filter
/sort
(single and multiple). The syntax to reference back relation fields isyourCollection_via_yourRelField.*
.⚠️ To avoid excessive joins, the nested relations resolver is now limited to max 6 level depth (the same asexpand
). Note that in the future there will be also more advanced and granular options to specify a subset of the fields that are filterable/sortable. -
Added support for multiple back/indirect relation
expand
and updated the keys to use the_via_
reference syntax (yourCollection_via_yourRelField
). To minimize the breaking changes, the old parenthesis reference syntax (yourCollection(yourRelField)
) will still continue to work but it is soft-deprecated and there will be a console log reminding you to change it to the new one. -
⚠️ Collections and fields are no longer allowed to have_via_
in their name to avoid collisions with the back/indirect relation reference syntax. -
Added
jsvm.Config.OnInit
optional config function to allow registering custom Go bindings to the JSVM. -
Added
@request.context
rule field that can be used to apply a different set of constraints based on the API rule execution context. For example, to disallow user creation by an OAuth2 auth, you could set for the users Create API rule@request.context != "oauth2"
. The currently supported@request.context
values are:default realtime protectedFile oauth2
-
Adjusted the
cron.Start()
to start the ticker at the00
second of the cron interval (#4394). Note that the cron format has only minute granularity and there is still no guarantee that the scheduled job will be always executed at the00
second. -
Fixed auto backups cron not reloading properly after app settings change (#4431).
-
Upgraded to
aws-sdk-go-v2
and added special handling for GCS to workaround the previous GCS headers signature issue that we had with v2. This should also fix the SVG/JSON zero response when using Cloudflare R2 (#4287, #2068, #2952).⚠️ If you are using S3 for uploaded files or backups, please verify that you have a green check in the Admin UI for your S3 configuration (I've tested the new version with GCS, MinIO, Cloudflare R2 and Wasabi). -
Added
:each
modifier support forfile
andrelation
type fields (previously it was supported only forselect
type fields). -
Other minor improvements (updated the
ghupdate
plugin to use the configured executable name when printing to the console, fixed the error reporting ofadmin update/delete
commands, etc.).
-
Ignore the JS required validations for disabled OIDC providers (#4322).
-
Allow
HEAD
requests to the/api/health
endpoint (#4310). -
Fixed the
editor
field value when visualized inside the View collection preview panel. -
Manually clear all TinyMCE events on editor removal (workaround for tinymce#9377).
-
Fixed
@request.auth.*
initialization side-effect which caused the current authenticated user email to not being returned in the user auth response (#2173). The current authenticated user email should be accessible always no matter of theemailVisibility
state. -
Fixed
RecordUpsert.RemoveFiles
godoc example. -
Bumped to
NumCPU()+2
thethumbGenSem
limit as some users reported that it was too restrictive.
- Small fix for the Admin UI related to the Settings > Sync menu not being visible even when the "Hide controls" toggle is off.
-
Added Bitbucket OAuth2 provider (#3948; thanks @aabajyan).
-
Mark user as verified on confirm password reset (#4066). If the user email has changed after issuing the reset token (eg. updated by an admin), then the
verified
user state remains unchanged. -
Added support for loading a serialized json payload for
multipart/form-data
requests using the special@jsonPayload
key. This is intended to be used primarily by the SDKs to resolve js-sdk#274. -
Added graceful OAuth2 redirect error handling (#4177). Previously on redirect error we were returning directly a standard json error response. Now on redirect error we'll redirect to a generic OAuth2 failure screen (similar to the success one) and will attempt to auto close the OAuth2 popup. The SDKs are also updated to handle the OAuth2 redirect error and it will be returned as Promise rejection of the
authWithOAuth2()
call. -
Exposed
$apis.gzip()
and$apis.bodyLimit(bytes)
middlewares to the JSVM. -
Added
TestMailer.SentMessages
field that holds all sent test app emails until cleanup. -
Optimized the cascade delete of records with multiple
relation
fields. -
Updated the
serve
andadmin
commands error reporting. -
Minor Admin UI improvements (reduced the min table row height, added option to duplicate fields, added new TinyMCE codesample plugin languages, hide the collection sync settings when the
Settings.Meta.HideControls
is enabled, etc.)
- Fixed the Admin UI auto indexes update when renaming fields with a common prefix (#4160).
-
Fixed JSVM types generation for functions with omitted arg types (#4145).
-
Updated Go deps.
- Minor CSS fix for the Admin UI to prevent the searchbar within a popup from expanding too much and pushing the controls out of the visible area (#4079).
- Small fix for a regression introduced with the recent
json
field changes that was causing View collection column expressions recognized asjson
to fail to resolve (#4072).
-
Fixed the
json
field query comparisons to work correctly with plain JSON values likenull
,bool
number
, etc. (#4068). Since there are plans in the future to allow custom SQLite builds and also in some situations it may be useful to be able to distinguishNULL
from''
, for thejson
fields (and for any other future non-standard field) we no longer applyCOALESCE
by default, aka.:Dataset: 1) data: json(null) 2) data: json('') For the filter "data = null" only 1) will resolve to TRUE. For the filter "data = ''" only 2) will resolve to TRUE.
-
Minor Go tests improvements
- Sorted the record cascade delete references to ensure that the delete operation will preserve the order of the fired events when running the tests.
- Marked some of the tests as safe for parallel execution to speed up a little the GitHub action build times.
-
Added
sleep(milliseconds)
JSVM binding. It works the same way as Gotime.Sleep()
, aka. it pauses the goroutine where the JSVM code is running. -
Fixed multi-line text paste in the Admin UI search bar (#4022).
-
Fixed the monospace font loading in the Admin UI.
-
Fixed various reported docs and code comment typos.
-
Added
--dev
flag and its accompanyingapp.IsDev()
method (in place of the previously removed--debug
) to assist during development (#3918). The--dev
flag prints in the console "everything" and more specifically:- the data DB SQL statements
- all
app.Logger().*
logs (debug, info, warning, error, etc.), no matter of the logs persistence settings in the Admin UI
-
Minor Admin UI fixes:
- Fixed the log
error
label text wrapping. - Added the log
referer
(when it is from a different source) anddetails
labels in the logs listing. - Removed the blank current time entry from the logs chart because it was causing confusion when used with custom time ranges.
- Updated the SQL syntax highlighter and keywords autocompletion in the Admin UI to recognize
CAST(x as bool)
expressions.
- Fixed the log
-
Replaced the default API tests timeout with a new
ApiScenario.Timeout
option (#3930). A negative or zero value means no tests timeout. If a single API test takes more than 3s to complete it will have a log message visible when the test fails or whengo test -v
flag is used. -
Added timestamp at the beginning of the generated JSVM types file to avoid creating it everytime with the app startup.
-
Added
expand
,filter
,fields
, custom query and headers parameters support for the realtime subscriptions. Requires JS SDK v0.20.0+ or Dart SDK v0.17.0+.// JS SDK v0.20.0 pb.collection("example").subscribe("*", (e) => { ... }, { expand: "someRelField", filter: "status = 'active'", fields: "id,expand.someRelField.*:excerpt(100)", })
// Dart SDK v0.17.0 pb.collection("example").subscribe("*", (e) { ... }, expand: "someRelField", filter: "status = 'active'", fields: "id,expand.someRelField.*:excerpt(100)", )
-
Generalized the logs to allow any kind of application logs, not just requests.
The new
app.Logger()
implements the standardlog/slog
interfaces available with Go 1.21.// Go: https://pocketbase.io/docs/go-logging/ app.Logger().Info("Example message", "total", 123, "details", "lorem ipsum...") // JS: https://pocketbase.io/docs/js-logging/ $app.logger().info("Example message", "total", 123, "details", "lorem ipsum...")
For better performance and to minimize blocking on hot paths, logs are currently written with debounce and on batches:
- 3 seconds after the last debounced log write
- when the batch threshold is reached (currently 200)
- right before app termination to attempt saving everything from the existing logs queue
Some notable log related changes:
-
⚠️ Bumped the minimum required Go version to 1.21. -
⚠️ Removed_requests
table in favor of the generalized_logs
. Note that existing logs will be deleted! -
⚠️ Renamed the followingDao
log methods:Dao.RequestQuery(...) -> Dao.LogQuery(...) Dao.FindRequestById(...) -> Dao.FindLogById(...) Dao.RequestsStats(...) -> Dao.LogsStats(...) Dao.DeleteOldRequests(...) -> Dao.DeleteOldLogs(...) Dao.SaveRequest(...) -> Dao.SaveLog(...)
-
⚠️ Removedapp.IsDebug()
and the--debug
flag. This was done to avoid the confusion with the new logger and its debug severity level. If you want to store debug logs you can set-4
as min log level from the Admin UI. -
Refactored Admin UI Logs:
- Added new logs table listing.
- Added log settings option to toggle the IP logging for the activity logger.
- Added log settings option to specify a minimum log level.
- Added controls to export individual or bulk selected logs as json.
- Other minor improvements and fixes.
-
Added new
filesystem/System.Copy(src, dest)
method to copy existing files from one location to another. This is usually useful when duplicating records withfile
field(s) programmatically. -
Added
filesystem.NewFileFromUrl(ctx, url)
helper method to construct a*filesystem.BytesReader
file from the specified url. -
OAuth2 related additions:
-
Added new
PKCE()
andSetPKCE(enable)
OAuth2 methods to indicate whether the PKCE flow is supported or not. The PKCE value is currently configurable from the UI only for the OIDC providers. This was added to accommodate OIDC providers that may throw an error if unsupported PKCE params are submitted with the auth request (eg. LinkedIn; see #3799). -
Added new
displayName
field for eachlistAuthMethods()
OAuth2 provider item. The value of thedisplayName
property is currently configurable from the UI only for the OIDC providers. -
Added
expiry
field to the OAuth2 user response containing the optional expiration time of the OAuth2 access token (#3617). -
Allow a single OAuth2 user to be used for authentication in multiple auth collection.
⚠️ Because now you can have more than one external provider withcollectionId-provider-providerId
pair,Dao.FindExternalAuthByProvider(provider, providerId)
method was removed in favour of the more genericDao.FindFirstExternalAuthByExpr(expr)
.
-
-
Added
onlyVerified
auth collection option to globally disallow authentication requests for unverified users. -
Added support for single line comments (ex.
// your comment
) in the API rules and filter expressions. -
Added support for specifying a collection alias in
@collection.someCollection:alias.*
. -
Soft-deprecated and renamed
app.Cache()
withapp.Store()
. -
Minor JSVM updates and fixes:
-
Updated
$security.parseUnverifiedJWT(token)
and$security.parseJWT(token, key)
to return the token payload result as plain object. -
Added
$apis.requireGuestOnly()
middleware JSVM binding (#3896).
-
-
Use
IS NOT
instead of!=
as not-equal SQL query operator to handle the cases when comparing with nullable columns or expressions (eg.json_extract
overjson
field). Based on my local dataset I wasn't able to find a significant difference in the performance between the 2 operators, but if you stumble on a query that you think may be affected negatively by this, please report it and I'll test it further. -
Added
MaxSize
json
field option to prevent storing large json data in the db (#3790). Existingjson
fields are updated with a system migration to have a ~2MB size limit (it can be adjusted from the Admin UI). -
Fixed negative string number normalization support for the
json
field type. -
Trigger the
app.OnTerminate()
hook onapp.Restart()
call. A new boolIsRestart
field was also added to thecore.TerminateEvent
event. -
Fixed graceful shutdown handling and speed up a little the app termination time.
-
Limit the concurrent thumbs generation to avoid high CPU and memory usage in spiky scenarios (#3794; thanks @t-muehlberger). Currently the max concurrent thumbs generation processes are limited to "total of logical process CPUs + 1". This is arbitrary chosen and may change in the future depending on the users feedback and usage patterns. If you are experiencing OOM errors during large image thumb generations, especially in container environment, you can try defining the
GOMEMLIMIT=500MiB
env variable before starting the executable. -
Slightly speed up (~10%) the thumbs generation by changing from cubic (
CatmullRom
) to bilinear (Linear
) resampling filter (the quality difference is very little). -
Added a default red colored Stderr output in case of a console command error. You can now also silence individually custom commands errors using the
cobra.Command.SilenceErrors
field. -
Fixed links formatting in the autogenerated html->text mail body.
-
Removed incorrectly imported empty
local('')
font-face declarations.
-
Fixed TinyMCE source code viewer textarea styles (#3715).
-
Fixed
text
field min/max validators to properly count multi-byte characters (#3735). -
Allowed hyphens in
username
(#3697). More control over the system fields settings will be available in the future. -
Updated the JSVM generated types to use directly the value type instead of
* | undefined
union in functions/methods return declarations.
-
Added the release notes to the console output of
./pocketbase update
(#3685). -
Added missing documentation for the JSVM
$mails.*
bindings. -
Relaxed the OAuth2 redirect url validation to allow any string value (#3689; thanks @sergeypdev). Note that the redirect url format is still bound to the accepted values by the specific OAuth2 provider.
-
Fixed
tokenizer.Scan()/ScanAll()
to ignore the separators from the default trim cutset. An option to return also the empty found tokens was also added viaTokenizer.KeepEmptyTokens(true)
. This should fix the parsing of whitespace characters around view query column names when no quotes are used (#3616). -
Fixed the
:excerpt(max, withEllipsis?)
fields
query param modifier to properly add space to the generated text fragment after block tags.
-
Added Patreon OAuth2 provider (#3323; thanks @ghostdevv).
-
Added mailcow OAuth2 provider (#3364; thanks @thisni1s).
-
Added support for
:excerpt(max, withEllipsis?)
fields
modifier that will return a short plain text version of any string value (html tags are stripped). This could be used to minimize the downloaded json data when listing records with largeeditor
html values.await pb.collection("example").getList(1, 20, { "fields": "*,description:excerpt(100)" })
-
Several Admin UI improvements:
- Count the total records separately to speed up the query execution for large datasets (#3344).
- Enclosed the listing scrolling area within the table so that the horizontal scrollbar and table header are always reachable (#2505).
- Allowed opening the record preview/update form via direct URL (#2682).
- Reintroduced the local
date
field tooltip on hover. - Speed up the listing loading times for records with large
editor
field values by initially fetching only a partial of the records data (the complete record data is loaded on record preview/update). - Added "Media library" (collection images picker) support for the TinyMCE
editor
field. - Added support to "pin" collections in the sidebar.
- Added support to manually resize the collections sidebar.
- More clear "Nonempty" field label style.
- Removed the legacy
.woff
and.ttf
fonts and keep only.woff2
.
-
Removed the explicit
Content-Type
charset from the realtime response due to compatibility issues with IIS (#3461). TheConnection:keep-alive
realtime response header was also removed as it is not really used with HTTP2 anyway. -
Added new JSVM bindings:
new Cookie({ ... })
constructor for creating*http.Cookie
equivalent value.new SubscriptionMessage({ ... })
constructor for creating a custom realtime subscription payload.- Soft-deprecated
$os.exec()
in favour of$os.cmd()
to make it more clear that the call only prepares the command and doesn't execute it.
-
⚠️ Bumped the min required Go version to 1.19.
-
Added global
raw
template function to allow outputting raw/verbatim HTML content in the JSVM templates (#3476).{{.description|raw}}
-
Trimmed view query semicolon and allowed single quotes for column aliases (#3450). Single quotes are usually not a valid identifier quote characters, but for resilience and compatibility reasons SQLite allows them in some contexts where only an identifier is expected.
-
Bumped the GitHub action to use min Go 1.21.2 (the fixed issues are not critical as they are mostly related to the compiler/build tools).
-
Fixed empty thumbs directories not getting deleted on Windows after deleting a record img file (#3382).
-
Updated the generated JSVM typings to silent the TS warnings when trying to access a field/method in a Go->TS interface.
- Minor fix for the View collections API Preview and Admin UI listings incorrectly showing the
created
andupdated
fields asN/A
when the view query doesn't have them.
-
Fixed JS error in the Admin UI when listing records with invalid
relation
field value (#3372). This could happen usually only during custom SQL import scripts or when directly modifying the record field value without data validations. -
Updated Go deps and the generated JSVM types.
-
Return the response headers and cookies in the
$http.send()
result (#3310). -
Added more descriptive internal error message for missing user/admin email on password reset requests.
-
Updated Go deps.
- Fixed minor Admin UI JS error in the auth collection options panel introduced with the change from v0.18.4.
- Added escape character (
\
) support in the Admin UI to allow usingselect
field values with comma (#2197).
-
Exposed a global JSVM
readerToString(reader)
helper function to allow reading Goio.Reader
values (#3273). -
Bumped the GitHub action to use min Go 1.21.1 for the prebuilt executable since it contains some minor
html/template
andnet/http
security fixes.
-
Prevent breaking the record form in the Admin UI in case the browser's localStorage quota has been exceeded when uploading or storing large
editor
values (#3265). -
Updated docs and missing JSVM typings.
-
Exposed additional crypto primitives under the
$security.*
JSVM namespace (#3273):// HMAC with SHA256 $security.hs256("hello", "secret") // HMAC with SHA512 $security.hs512("hello", "secret") // compare 2 strings with a constant time $security.equal(hash1, hash2)
- Excluded the local temp dir from the backups (#3261).
-
Simplified the
serve
command to accept domain name(s) as argument to reduce any additional manual hosts setup that sometimes previously was needed when deploying on production (#3190)../pocketbase serve yourdomain.com
-
Added
fields
wildcard (*
) support. -
Added option to upload a backup file from the Admin UI (#2599).
-
Registered a custom Deflate compressor to speedup (nearly 2-3x) the backups generation for the sake of a small zip size increase. Based on several local tests,
pb_data
of ~500MB (from which ~350MB+ are several hundred small files) results in a ~280MB zip generated for ~11s (previously it resulted in ~250MB zip but for ~35s). -
Added the application name as part of the autogenerated backup name for easier identification (#3066).
-
Added new
SmtpConfig.LocalName
option to specify a custom domain name (or IP address) for the initial EHLO/HELO exchange (#3097). This is usually required for verification purposes only by some SMTP providers, such as on-premise Gmail SMTP-relay. -
Added
NoDecimal
number
field option. -
editor
field improvements:- Added new "Strip urls domain" option to allow controlling the default TinyMCE urls behavior (default to
false
for new content). - Normalized pasted text while still preserving links, lists, tables, etc. formatting (#3257).
- Added new "Strip urls domain" option to allow controlling the default TinyMCE urls behavior (default to
-
Added option to auto generate admin and auth record passwords from the Admin UI.
-
Added JSON validation and syntax highlight for the
json
field in the Admin UI (#3191). -
Added datetime filter macros:
// all macros are UTC based @second - @now second number (0-59) @minute - @now minute number (0-59) @hour - @now hour number (0-23) @weekday - @now weekday number (0-6) @day - @now day number @month - @now month number @year - @now year number @todayStart - beginning of the current day as datetime string @todayEnd - end of the current day as datetime string @monthStart - beginning of the current month as datetime string @monthEnd - end of the current month as datetime string @yearStart - beginning of the current year as datetime string @yearEnd - end of the current year as datetime string
-
Added cron expression macros (#3132):
@yearly - "0 0 1 1 *" @annually - "0 0 1 1 *" @monthly - "0 0 1 * *" @weekly - "0 0 * * 0" @daily - "0 0 * * *" @midnight - "0 0 * * *" @hourly - "0 * * * *"
-
⚠️ Added offset argumentDao.FindRecordsByFilter(collection, filter, sort, limit, offset, [params...])
. If you don't need an offset, you can set it to0
. -
To minimize the footguns with
Dao.FindFirstRecordByFilter()
andDao.FindRecordsByFilter()
, the functions now supports an optional placeholder params argument that is safe to be populated with untrusted user input. The placeholders are in the same format as when binding regular SQL parameters.// unsanitized and untrusted filter variables status := "..." author := "..." app.Dao().FindFirstRecordByFilter("articles", "status={:status} && author={:author}", dbx.Params{ "status": status, "author": author, }) app.Dao().FindRecordsByFilter("articles", "status={:status} && author={:author}", "-created", 10, 0, dbx.Params{ "status": status, "author": author, })
-
Added JSVM
$mails.*
binds for the corresponding Go mails package functions. -
Added JSVM helper crypto primitives under the
$security.*
namespace:$security.md5(text) $security.sha256(text) $security.sha512(text)
-
⚠️ DeprecatedRelationOptions.DisplayFields
in favor of the newSchemaField.Presentable
option to avoid the duplication when a single collection is referenced more than once and/or by multiple other collections. -
⚠️ Fill theLastVerificationSentAt
andLastResetSentAt
fields only after a successfull email send (#3121). -
⚠️ Skip APIfields
json transformations for non 20x responses (#3176). -
⚠️ Changes totests.ApiScenario
struct:-
The
ApiScenario.AfterTestFunc
now receive as 3rd argument*http.Response
pointer instead of*echo.Echo
as the latter is not really useful in this context.// old AfterTestFunc: func(t *testing.T, app *tests.TestApp, e *echo.Echo) // new AfterTestFunc: func(t *testing.T, app *tests.TestApp, res *http.Response)
-
The
ApiScenario.TestAppFactory
now accept the test instance as argument and no longer expect an error as return result (#3025).// old TestAppFactory: func() (*tests.TestApp, error) // new TestAppFactory: func(t *testing.T) *tests.TestApp
Returning a
nil
app instance from the factory results in test failure. You can enforce a custom test failure by callingt.Fatal(err)
inside the factory.
-
-
Bumped the min required TLS version to 1.2 in order to improve the cert reputation score.
-
Reduced the default JSVM prewarmed pool size to 25 to reduce the initial memory consumptions (you can manually adjust the pool size with
--hooksPool=50
if you need to, but the default should suffice for most cases). -
Update
gocloud.dev
dependency to v0.34 and explicitly set the newNoTempDir
fileblob option to prevent the cross-device link error introduced with v0.33. -
Other minor Admin UI and docs improvements.
-
Fixed the autogenerated
down
migrations to properly revert the old collection rules in case a change was made inup
(#3192; thanks @impact-merlinmarek). Existingdown
migrations can't be fixed but that should be ok as usually thedown
migrations are rarely used against prod environments since they can cause data loss and, while not ideal, the previous old behavior of always setting the rules tonull/nil
is safer than not updating the rules at all. -
Updated some Go deps.
- Fixed JSVM
require()
file path error when using Windows-style path delimiters (#3163).
- Added quotes around the wrapped view query columns introduced with v0.17.4.
-
Fixed Views record retrieval when numeric id is used (#3110). With this fix we also now properly recognize
CAST(... as TEXT)
andCAST(... as BOOLEAN)
astext
andbool
fields. -
Fixed
relation
"Cascade delete" tooltip message (#3098). -
Fixed jsvm error message prefix on failed migrations (#3103; thanks @nzhenev).
-
Disabled the initial Admin UI admins counter cache when there are no initial admins to allow detecting externally created accounts (eg. with the
admin
command) (#3106). -
Downgraded
google/go-cloud
dependency to v0.32.0 until v0.34.0 is released to prevent theos.TempDir
cross-device link
errors as too many users complained about it.
-
Fixed Docker
cross-device link
error when creatingpb_data
backups on a local mounted volume (#3089). -
Fixed the error messages for relation to views (#3090).
-
Always reserve space for the scrollbar to reduce the layout shifts in the Admin UI records listing due to the deprecated
overflow: overlay
. -
Enabled lazy loading for the Admin UI thumb images.
-
Soft-deprecated
$http.send({ data: object, ... })
in favour of$http.send({ body: rawString, ... })
to allow sending non-JSON body with the request (#3058). The existingdata
prop will still work, but it is recommended to usebody
instead (to send JSON you can useJSON.stringify(...)
as body value). -
Added
core.RealtimeConnectEvent.IdleTimeout
field to allow specifying a different realtime idle timeout duration per client basis (#3054). -
Fixed
apis.RequestData
deprecation log note (#3068; thanks @gungjodi).
-
Use relative path when redirecting to the OAuth2 providers page in the Admin UI to support subpath deployments (#3026; thanks @sonyarianto).
-
Manually trigger the
OnBeforeServe
hook fortests.ApiScenario
(#3025). -
Trigger the JSVM
cronAdd()
handler only on appserve
to prevent unexpected (and eventually duplicated) cron handler calls when custom console commands are used (#3024). -
The
console.log()
messages are now written to thestdout
instead ofstderr
.
-
New more detailed guides for using PocketBase as framework (both Go and JS). If you find any typos or issues with the docs please report them in https://github.com/pocketbase/site.
-
Added new experimental JavaScript app hooks binding via goja. They are available by default with the prebuilt executable if you create
*.pb.js
file(s) in thepb_hooks
directory. Lower your expectations because the integration comes with some limitations. For more details please check the Extend with JavaScript guide. Optionally, you can also enable the JS app hooks as part of a custom Go build for dynamic scripting but you need to register thejsvm
plugin manually:jsvm.MustRegister(app core.App, config jsvm.Config{})
-
Added Instagram OAuth2 provider (#2534; thanks @pnmcosta).
-
Added VK OAuth2 provider (#2533; thanks @imperatrona).
-
Added Yandex OAuth2 provider (#2762; thanks @imperatrona).
-
Added new fields to
core.ServeEvent
:type ServeEvent struct { App App Router *echo.Echo // new fields Server *http.Server // allows adjusting the HTTP server config (global timeouts, TLS options, etc.) CertManager *autocert.Manager // allows adjusting the autocert options (cache dir, host policy, etc.) }
-
Added
record.ExpandedOne(rel)
andrecord.ExpandedAll(rel)
helpers to retrieve casted single or multiple expand relations from the already loaded "expand" Record data. -
Added rule and filter record
Dao
helpers:app.Dao().FindRecordsByFilter("posts", "title ~ 'lorem ipsum' && visible = true", "-created", 10) app.Dao().FindFirstRecordByFilter("posts", "slug='test' && active=true") app.Dao().CanAccessRecord(record, requestInfo, rule)
-
Added
Dao.WithoutHooks()
helper to create a newDao
from the current one but without the create/update/delete hooks. -
Use a default fetch function that will return all relations in case the
fetchFunc
argument ofDao.ExpandRecord(record, expands, fetchFunc)
andDao.ExpandRecords(records, expands, fetchFunc)
isnil
. -
For convenience it is now possible to call
Dao.RecordQuery(collectionModelOrIdentifier)
with just the collection id or name. In case an invalid collection id/name string is passed the query will be resolved with cancelled context error. -
Refactored
apis.ApiError
validation errors serialization to allowmap[string]error
andmap[string]any
when generating the public safe formattedApiError.Data
. -
Added support for wrapped API errors (in case Go 1.20+ is used with multiple wrapped errors, the first
apis.ApiError
takes precedence). -
Added
?download=1
file query parameter to the file serving endpoint to force the browser to always download the file and not show its preview. -
Added new utility
github.com/pocketbase/pocketbase/tools/template
subpackage to assist with rendering HTML templates using the standard Gohtml/template
andtext/template
syntax. -
Added
types.JsonMap.Get(k)
andtypes.JsonMap.Set(k, v)
helpers for the cases where the type aliased direct map access is not allowed (eg. in goja). -
Soft-deprecated
security.NewToken()
in favor ofsecurity.NewJWT()
. -
Hook.Add()
andHook.PreAdd
now returns a unique string identifier that could be used to remove the registered hook handler viaHook.Remove(handlerId)
. -
Changed the after* hooks to be called right before writing the user response, allowing users to return response errors from the after hooks. There is also no longer need for returning explicitly
hook.StopPropagtion
when writing custom response body in a hook because we will skip the finalizer response body write if a response was already "committed". -
⚠️ Renamed*Options{}
toConfig{}
for consistency and replaced the unnecessary pointers with their value equivalent to keep the applied configuration defaults isolated within their function calls:old: pocketbase.NewWithConfig(config *pocketbase.Config) *pocketbase.PocketBase new: pocketbase.NewWithConfig(config pocketbase.Config) *pocketbase.PocketBase old: core.NewBaseApp(config *core.BaseAppConfig) *core.BaseApp new: core.NewBaseApp(config core.BaseAppConfig) *core.BaseApp old: apis.Serve(app core.App, options *apis.ServeOptions) error new: apis.Serve(app core.App, config apis.ServeConfig) (*http.Server, error) old: jsvm.MustRegisterMigrations(app core.App, options *jsvm.MigrationsOptions) new: jsvm.MustRegister(app core.App, config jsvm.Config) old: ghupdate.MustRegister(app core.App, rootCmd *cobra.Command, options *ghupdate.Options) new: ghupdate.MustRegister(app core.App, rootCmd *cobra.Command, config ghupdate.Config) old: migratecmd.MustRegister(app core.App, rootCmd *cobra.Command, options *migratecmd.Options) new: migratecmd.MustRegister(app core.App, rootCmd *cobra.Command, config migratecmd.Config)
-
⚠️ Changed the type ofsubscriptions.Message.Data
fromstring
to[]byte
becauseData
usually is a json bytes slice anyway. -
⚠️ Renamedmodels.RequestData
tomodels.RequestInfo
and soft-deprecatedapis.RequestData(c)
in favor ofapis.RequestInfo(c)
to avoid the stuttering with theData
field. The oldapis.RequestData()
method still works to minimize the breaking changes but it is recommended to replace it withapis.RequestInfo(c)
. -
⚠️ Changes to the List/Search APIs-
Added new query parameter
?skipTotal=1
to skip theCOUNT
query performed with the list/search actions (#2965). If?skipTotal=1
is set, the response fieldstotalItems
andtotalPages
will have-1
value (this is to avoid having different JSON responses and to differentiate from the zero default). With the latest JS SDK 0.16+ and Dart SDK v0.11+ versionsskipTotal=1
is set by default for thegetFirstListItem()
andgetFullList()
requests. -
The count and regular select statements also now executes concurrently, meaning that we no longer perform normalization over the
page
parameter and in case the user request a page that doesn't exist (eg.?page=99999999
) we'll return emptyitems
array. -
Reverted the default
COUNT
column toid
as there are some common situations where it can negatively impact the query performance. Additionally, from this version we also setPRAGMA temp_store = MEMORY
so that also helps with the temp B-TREE creation whenid
is used. There are still scenarios whereCOUNT
queries withrowid
executes faster, but the majority of the time when nested relations lookups are used it seems to have the opposite effect (at least based on the benchmarks dataset).
-
-
⚠️ Disallowed relations to views from non-view collections (#3000). The change was necessary because I wasn't able to find an efficient way to track view changes and the previous behavior could have too many unexpected side-effects (eg. view with computed ids). There is a system migration that will convert the existing viewrelation
fields tojson
(multiple) andtext
(single) fields. This could be a breaking change if you haverelation
to view and useexpand
or some of therelation
view fields as part of a collection rule. -
⚠️ Added an extraaction
argument to theDao
hooks to allow skipping the default persist behavior. In preparation for the logs generalization, theDao.After*Func
methods now also allow returning an error. -
Allowed
0
asRelationOptions.MinSelect
value to avoid the ambiguity between 0 and non-filled input value (#2817). -
Fixed zero-default value not being used if the field is not explicitly set when manually creating records (#2992). Additionally,
record.Get(field)
will now always return normalized value (the same as in the json serialization) for consistency and to avoid ambiguities with what is stored in the related DB table. The schema fields columnsDEFAULT
definition was also updated for new collections to ensure thatNULL
values can't be accidentally inserted. -
Fixed
migrate down
not returning the correctlastAppliedMigrations()
when the stored migration applied time is in seconds. -
Fixed realtime delete event to be called after the record was deleted from the DB (including transactions and cascade delete operations).
-
Other minor fixes and improvements (typos and grammar fixes, updated dependencies, removed unnecessary 404 error check in the Admin UI, etc.).
- Added multiple valued fields (
relation
,select
,file
) normalizations to ensure that the zero-default value of a newly created multiple field is applied for already existing data (#2930).
- Register the
eagerRequestInfoCache
middleware only for the internalapi
group routes to avoid conflicts with custom route handlers (#2914).
-
Fixed unique validator detailed error message not being returned when camelCase field name is used (#2868).
-
Updated the index parser to allow no space between the table name and the columns list (#2864).
-
Updated go deps.
- Minor optimization for the list/search queries to use
rowid
with theCOUNT
statement when available. This eliminates the temp B-TREE step when executing the query and for large datasets (eg. 150k) it could have 10x improvement (from ~580ms to ~60ms).
-
Fixed collection index column sort normalization in the Admin UI (#2681; thanks @SimonLoir).
-
Removed unnecessary admins count in
apis.RequireAdminAuthOnlyIfAny()
middleware (#2726; thanks @svekko). -
Fixed
multipart/form-data
request bind not populating map array values (#2763). -
Upgraded npm and Go dependencies.
-
Fixed the Admin UI serialization of implicit relation display fields (#2675).
-
Reset the Admin UI sort in case the active sort collection field is renamed or deleted.
-
Fixed the selfupdate command not working on Windows due to missing
.exe
in the extracted binary path (#2589). Note that the command on Windows will work from v0.16.4+ onwards, meaning that you still will have to update manually one more time to v0.16.4. -
Added
int64
,int32
,uint
,uint64
anduint32
support when scanningtypes.DateTime
(#2602) -
Updated dependencies.
-
Fixed schema fields sort not working on Safari/Gnome Web (#2567).
-
Fixed default
PRAGMA
s not being applied for new connections (#2570).
-
Fixed backups archive not excluding the local
backups
directory on Windows (#2548). -
Changed file field to not use
dataTransfer.effectAllowed
when dropping files since it is not reliable and consistent across different OS and browsers (#2541). -
Auto register the initial generated snapshot migration to prevent incorrectly reapplying the snapshot on Docker restart (#2551).
-
Fixed missing view id field error message typo.
-
Fixed backup restore not working in a container environment when
pb_data
is mounted as volume (#2519). -
Fixed Dart SDK realtime API preview example (#2523; thanks @xFrann).
-
Fixed typo in the backups create panel (#2526; thanks @dschissler).
-
Removed unnecessary slice length check in
list.ExistInSlice
(#2527; thanks @KunalSin9h). -
Avoid mutating the cached request data on OAuth2 user create (#2535).
-
Fixed Export Collections "Download as JSON" (#2540).
-
Fixed file field drag and drop not working in Firefox and Safari (#2541).
-
Added automated backups (+ cron rotation) APIs and UI for the
pb_data
directory. The backups can be also initialized programmatically usingapp.CreateBackup("backup.zip")
. There is also experimental restore method -app.RestoreBackup("backup.zip")
(currently works only on UNIX systems as it relies on execve). The backups can be stored locally or in external S3 storage (it has its own configuration, separate from the file uploads storage filesystem). -
Added option to limit the returned API fields using the
?fields
query parameter. The "fields picker" is applied forSearchResult.Items
and every other JSON response. For example:// original: {"id": "RECORD_ID", "name": "abc", "description": "...something very big...", "items": ["id1", "id2"], "expand": {"items": [{"id": "id1", "name": "test1"}, {"id": "id2", "name": "test2"}]}} // output: {"name": "abc", "expand": {"items": [{"name": "test1"}, {"name": "test2"}]}} const result = await pb.collection("example").getOne("RECORD_ID", { expand: "items", fields: "name,expand.items.name", })
-
Added new
./pocketbase update
command to selfupdate the prebuilt executable (with option to generate a backup of yourpb_data
). -
Added new
./pocketbase admin
console command:// creates new admin account ./pocketbase admin create test@example.com 123456890 // changes the password of an existing admin account ./pocketbase admin update test@example.com 0987654321 // deletes single admin account (if exists) ./pocketbase admin delete test@example.com
-
Added
apis.Serve(app, options)
helper to allow starting the API server programmatically. -
Updated the schema fields Admin UI for "tidier" fields visualization.
-
Updated the logs "real" user IP to check for
Fly-Client-IP
header and changed theX-Forward-For
header to use the first non-empty leftmost-ish IP as it the closest to the "real IP". -
Added new
tools/archive
helper subpackage for managing archives (currently works only with zip). -
Added new
tools/cron
helper subpackage for scheduling task using cron-like syntax (this eventually may get exported in the future in a separate repo). -
Added new
Filesystem.List(prefix)
helper to retrieve a flat list with all files under the provided prefix. -
Added new
App.NewBackupsFilesystem()
helper to create a dedicated filesystem abstraction for managing app data backups. -
Added new
App.OnTerminate()
hook (executed right before app termination, eg. onSIGTERM
signal). -
Added
accept
file field attribute with the field MIME types (#2466; thanks @Nikhil1920). -
Added support for multiple files sort in the Admin UI (#2445).
-
Added support for multiple relations sort in the Admin UI.
-
Added
meta.isNew
to the OAuth2 auth JSON response to indicate a newly OAuth2 created PocketBase user.