diff --git a/Migration-guide-from-Version-5.5-to-5.6.md b/Migration-guide-from-Version-5.5-to-5.6.md new file mode 100644 index 0000000..81e00bc --- /dev/null +++ b/Migration-guide-from-Version-5.5-to-5.6.md @@ -0,0 +1,39 @@ +![Plan Header](https://raw.githubusercontent.com/plan-player-analytics/drawio-diagrams-storage/master/image/header/main-header-Plan.jpg) +# 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. + +## 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` (Needs `plan.setgroup.other` permission) +- Go to `https:///manage` and setup permissions to how you like them +- Give your players `plan.webgroup.{groupname}` permission (eg `plan.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: +![image](https://github.com/plan-player-analytics/Plan/assets/24460436/c17710db-008b-4b15-8a54-a21cb368454f) + +## 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. \ No newline at end of file