Migration guide from Version 5.5 to 5.6
This page contains steps that you might want to do when updating to 5.6.
At minimum the server hosting webserver needs to be updated, but I suggest all servers are updated to the new version where possible. After update old versions will be unable to read/write web users.
You can use /plan servers to check if you have all servers updated.
Backup your database
5.6 modifies database schema so if you would like to return to 5.5 it is recommended to backup your database.
- If using MySQL/MariaDB, mysqldump/mariadbdump are recommended.
- If using SQLite, shutdown the server and copy database.db (Make sure database.db-shm or database.db-wal don't exist which suggests improper shutdown)
Setting up new web permission stuff
This only applies if you have HTTPS enabled.
The new web permission system is detailed here: https://github.com/plan-player-analytics/Plan/wiki/Web-permissions
- Make one web user admin:
/plan setgroup {username} admin(Needsplan.setgroup.otherpermission) - Go to
https://<plan webserver>/manageand setup permissions to how you like them - Give your players
plan.webgroup.{groupname}permission (egplan.webgroup.player). This will ensure they can continue to register users. - Delete legacy_level_x web groups.
| Legacy group | Equivalent new default group | What they can roughly see |
|---|---|---|
| didn't exist | admin | everything + editing permissions |
| legacy_level_0 | read_all | read access to everything except /errors and /docs |
| legacy_level_1 | player_analyst | query, players and all player pages |
| legacy_level_2 | player | own player page |
| legacy_level_100 | no_access | nothing |
Moving users happens by deleting the group and selecting where to move the existing users:
Migrate Html customizations of old frontend
Old frontend files are removed in 5.6 so old html customization no longer works. Migration guide: https://github.com/plan-player-analytics/Plan/wiki/Html-Customization--migration-guide-to-React
Fabric
5.6 only supports Fabric 1.20.2 so you may need to update Fabric before updating.