Upgrade instructions
[!IMPORTANT]
If you use the Aleph API, make sure to carefully review the following upgrade instructions.
Aleph 4.1 introduces changes to API keys:
- Users can now regenerate their API key from the user settings page.
- New API keys now expire automatically after 90 days. In order to continue accessing the Aleph API, users need to regenerate their API key before it expires. Users will receive email notifications 7 days before their API key expires, as well as on the day it expires.
- Users can only see their API key directly after it has been generated, but not again after that.
- New users won’t have an API key by default anymore, they need to actively generate an API key.
After upgrading to Aleph 4.1, to continue using existing API keys, you need to run the following command in an Aleph container:
aleph hash-plaintext-api-keys
Existing API keys won’t expire automatically, but you can optionally set them to expire after 90 days by running the following command in an Aleph container:
aleph reset-api-key-expiration
What’s Changed
-
Implement infinite scrolling for document search by @tillprochaska in Implement infinite scrolling for document search by tillprochaska · Pull Request #3855 · alephdata/aleph · GitHub
-
Fix infinite request loop if metadata request fails by @tillprochaska in Fix infinite request loop if metadata request fails by tillprochaska · Pull Request #3948 · alephdata/aleph · GitHub
-
Do not allow duplicate role memberships by @tillprochaska in Do not allow duplicate role memberships by tillprochaska · Pull Request #3815 · alephdata/aleph · GitHub
-
Make document search available in entity preview by @tillprochaska in Make document search available in entity preview by tillprochaska · Pull Request #3879 · alephdata/aleph · GitHub
-
Improved API key handling by @tillprochaska in Improved API key handling by tillprochaska · Pull Request #3094 · alephdata/aleph · GitHub
-
Update Prometheus exporter probes so they do not actually generate all metrics by @tillprochaska in Update Prometheus exporter probes so they do not actually generate all metrics by tillprochaska · Pull Request #3996 · alephdata/aleph · GitHub
-
Show login popup or redirect to OAuth provider when session token has expired by @tillprochaska in Show login popup or redirect to OAuth provider when session token has expired by tillprochaska · Pull Request #4000 · alephdata/aleph · GitHub
-
Fix edge case in metrics collector by @tillprochaska in Fix edge case in metrics collector by tillprochaska · Pull Request #3875 · alephdata/aleph · GitHub
-
Update documentation links in FAQ by @tillprochaska in Update documentation links in FAQ by tillprochaska · Pull Request #3873 · alephdata/aleph · GitHub
-
Add test to cover
last_login_attimestamp in OAuth workflow by @tillprochaska in Add test to cover `last_login_at` timestamp in OAuth workflow by tillprochaska · Pull Request #3878 · alephdata/aleph · GitHub -
e2e test fix: Use newer locator API, make worker start up properly by @stchris in e2e test fix: Use newer locator API, make worker start up properly by stchris · Pull Request #3877 · alephdata/aleph · GitHub
-
Use pg_isready in make upgrade instead of sleep by @stchris in Use pg_isready in make upgrade instead of sleep by stchris · Pull Request #3951 · alephdata/aleph · GitHub
-
Bump flask-cors from 4.0.0 to 4.0.2 by @dependabot in Bump flask-cors from 4.0.0 to 4.0.2 by dependabot[bot] · Pull Request #3885 · alephdata/aleph · GitHub
-
Add additional validation checks by @tillprochaska in Add additional validation checks by tillprochaska · Pull Request #4104 · alephdata/aleph · GitHub
-
Do not delete API key to enable rollbacks to previous version. by @tillprochaska in Do not delete API key to enable rollbacks to previous version. by tillprochaska · Pull Request #4105 · alephdata/aleph · GitHub
Full Changelog: Comparing 4.0.2...4.1.0 · alephdata/aleph · GitHub