Skip to content

v2.1.* to v2.1.4 Upgrade Guide

Jump to bottom
Sam edited this page Oct 25, 2021 · 2 revisions

Breaking Changes

  • path key from .env has been renamed to PROJECT_ROOT to avoid any confusion with the system $PATH environmental variable.
  • 'pf' Database: esiAccessToken column in character table charset updated from 'varchar256' to 'text'
  • new environment.ini key CCP_SSO_JWK_CLAIM needs to be added

Upgrade Steps:

This guide assumes you are using our Pathfinder-Containers solution for running Pathfinder. If you are not then your upgrade path will be slightly different, but hopefully this gives a general outline of the steps required.

  1. Rename the path variable in the .env file to PROJECT_ROOT. You can do this using an editor such as vim or nano. If you're unfamiliar with how to do this you can also try this solution from inside your pathfinder-containers project directory:
$ sed -i 's/^path\=/PROJECT_ROOT\=/g' ./.env && cat ./.env | grep -E 'path=|PROJECT_ROOT='

This will replace the variable name inside the file, and then print any lines with either 'path' or 'PROJECT_ROOT' to the console so you can check has been updated correctly.

  1. Check that the CCP_SSO_JWK_CLAIM key was added to your /static/pathfinder/environment.ini file by running:
$ grep "CCP_SSO_JWK_CLAIM" ./static/pathfinder/environment.ini

The expected result is CCP_SSO_JWK_CLAIM = login.eveonline.com

  1. Follow all of the steps in the General Upgrade Guide. It's especially import you do step 3. There will be an error on the PF database for the characters table. Press the "Fix Columns/Keys" button underneath the "pf" database section to fix it.

  2. If your project won't build (ie. docker-compose up --build fails, this could be due to merge conflicts in your docker-compose file. This will looks something like this:

<<<<<<< Updated upstream
      - "--certificatesresolvers.letsencrypt.acme.email=MYEMAIL@someemailprobablygmail.com"
=======
      - "--certificatesresolvers.letsencrypt.acme.storage=/letsencrypt/acme.json"
>>>>>>> Stashed changes

This block is asking you to keep one or the other. If you're unfamiliar with how to resolve these conflicts, and how significant-whitespace works in yml files, you might just want to paste over the whole file with the correct version with the staging letsencrypt lines removed.

  1. When your users try to log their characters back in, PF will generate a lot of errors about invalid refresh tokens. This is expected because the refresh tokens you have saved in the database are in the old format and cannot be used to generate new tokens. This will mean that your users need to perform SSO with all of their characters again. In theory they should see no errors, PF will internalize the errors, users will just see a blank character selection screen and be asked to log in.
Clone this wiki locally