Skip to content

v1.6.0
Compare
Choose a tag to compare
@github-actions github-actions released this 17 Mar 12:11
· 26 commits to master since this release
v1.6.0
595cb45
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

It's finally here! After some work we have started moving towards a more usable and open API for others to consume, with proper session handling (no more random logouts on server shutdowns!), improvements to ePubs, UX and some more!

See details below for more information (important notes are the breaking changes) and please fill an issue if you see anything weird, better be safe than sorry!

Breaking changes

  • The serve command is considered deprecated and will be removed in a future release. Right now just proxies to a new server command that is the one that should be used from now on.
  • The server command uses a new http backend. This should be transparent to users and all things should keep working as usual, but that meant refactoring some of the underlying systems too, so experiences may vary between deployments and operating systems. Please fill an issue if you see that something is not working as expected.
    • We are moving the API to a more stable, documented and with a proper code structure. Right now there's a mix between old and new endpoints until migration is completed. Check the documentation for more information on the new API and this roadmap filter to see progress on the API migration.
    • Authentication to the API now uses JWTs instead of session tokens and the endpoint has changed to a new one, please check the documentation mentioned above. This means that there's no longer logout issues when the server is restarted or when you log in in other computer/browser.
  • The --webroot flag no longer modifies the routes internally, is up to the user to proxy the routes properly to Shiori without the prefix used to serve it.
    That means that if you want to serve Shiori under domain.com/shiori you need to send the path back to Shiori without the /shiori prefix so routes keep working. This can be done in most reverse proxies that we're aware of. We provided a sample configuration for Nginx. PRs are welcome for other reverse proxies.
  • The shiori/gopher initial user is a full fledged user instead of being hardcoded into Shiori. If you want a new user you need to create a new owner user and then remove the shiori user.

Release cadence

Right now the release cadence has been slow because we made too many changes at once and we had to test and finish everything before doing this release. Plan moving forward is to iterate and release faster so we're planning smaller milestones to provide new features and fixes faster to you.

I will post an update announcement when the roadmap is reviewed.

What's Changed

New Contributors

Full Changelog: v1.5.5...v1.6.0

Contributors

fmartingr, shirayu, and 9 other contributors
Assets 9