Mirroristas/pockethost
2
0
Fork 0
mirror of https://github.com/pockethost/pockethost.git synced 2025-06-18 12:06:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
pockethost/packages/www/content/docs/usage/upgrading.md
Ben Allfree 01ebc69367 enh: rizzdown enhancements to documentation
2023-10-05 16:09:12 -07:00

3.6 KiB
Raw Blame History

title category description
Upgrading your Instance Version usage Learn how to upgrade your PocketHost instance version quickly and securely. Be it an automatic upgrade for minor updates or a manual upgrade for rarer and more substantial updates, our guide makes the process straightforward while prioritizing your project's data safety. Upgrade, but don't compromise.

Overview

Unlock the full potential of PocketHost by upgrading your instance version promptly and effortlessly. PocketHost's comprehensive support for all versions of PocketBase grants you the power to optimize your instance with the latest and most capable versions out there.

To upgrade your instance, take advantage of the Danger Zone in the instance details. Specify the desired PocketBase version using semver format. This upgrade can be automatic for minor updates or manual for more substantial changes.

Always initiate the upgrade process by backing up your instance for data integrity. In most scenarios, automatic upgrades are advised. Simply change to the new version you want. While specifying a semver range like ~0.16.0, the system will embrace any upcoming patch release without including major versions. After this step, you can take your instance out of maintenance to make it live.

In some exceptional cases, resort to manual upgrades. These steps require downloading your database via FTP, performing necessary upgrades according to PocketBase documentation, and re-uploading the database. After exiting maintenance mode, ensure to test your instance.

Upgrading your PocketHost instance means staying ahead and leveraging the best features it offers. But always emphasize protecting your project's data without compromising utility.

PocketHost supports all versions of PocketBase.

Your instance uses semver version (0.16.0) or semver range (~0.16.0) to describe which version of PocketBase to run.

You may change this using the Danger Zone in the instance details.

Automatic Upgrade Steps (most cases)

  1. Back up your instance
  2. Change to the new version you want. Typically, it is safe to use ~ in front, which will auto-upgrade any patch release. For example, if the current version of PocketBase is 0.16.5, then specifying a semver range of ~0.16.0 will match 0.16.6 when it is released, but will not match 0.17.0 when it is released. For now, locking to the minor version is advised until PocketBase reaches v1.0.
  3. Take your instance out of maintenance mode so it is once again live.

Manual Upgrade Steps (rare)

Sometimes, the automated upgrade is not possible or may leave your PocketHost instance in an unresponsive state because PocketBase exits when it notices a problem with the database schema. In that case, you must perform a manual upgrade.

  1. Back up your instance
  2. Put the instance in Maintenance Mode
  3. Update your instance to the target version you want.
  4. Download your database via FTP
  5. On your local machine, perform whatever upgrade steps are necessary according to the PocketBase documentation
  6. Upload your database via FTP again
  7. Take the instance out of Maintenance Mode and test

Caveats

  • Downgrading to an earlier version may work in some cases, but is not advised. See #271 for further details.
  • In some cases, you may need to
  • When a new version of PocketHost is run for the first time, it may run migrations on its system tables. These migrations are typically non-destructive