cachethq/core

Migrate v2.4 installations to v3.x

Open

#184 opened on Jan 15, 2025

 (1 comment) (0 reactions) (0 assignees)PHP (82 forks)github user discovery
help wanted

Repository metrics

Stars
 (227 stars)
PR merge metrics
 (Avg merge 10d 23h) (28 merged PRs in 30d)

Description

We need a method of migrating users from 2.4 to 3.x.

Things to consider:

  • Migrate settings
  • Migrate resources
  • Migrate subscriptions / subscribers
  • Migrate API Keys

AOB (please add to this list)


As a comment on the latter, once #183 is merged, we'll need to programmatically migrate users 2.4 API Keys to 3.x using something like the following

$v2ApiKey = $v2User->api_key;

$v3User->tokens()->create([
    'name' => 'v2.4 API Key',
    'token' => hash('sha256', $v2ApiKey),
    'abilities' => ['*'],
    'expires_at' => now()->addDays(90),
]);

@jbrooksuk We need to decide on the abilities and expires_at. IMO it makes sense to throw something into the upgrade documentation that old 2.4 API Keys will continue to work for up to 90 days. But if they want to use the API after that, then they'll need to generate a new API Token using the 3.x dashboard.

Contributor guide