Always remember to backup your data before updating.

Notable changes

System Theme (@Monirzadeh) #924

Shiori now allows you to change the theme to light/dark or follow the system configuration.

New migrations backend (@fmartingr) #876

The underlying migrations system has been rewritten to custom code removing the go-migrate dependency.

This not only removes one more dependency but also allows for more control over the migrations process by letting us add run code in a migration, for example, to update the database schema.

This should be transparent for all users but if you find any problems please report it

OpenBSD support (@pacoesteban) #780

This has been in the works for several months since we broke it around 1.5 but thanks to the above migration changes and some custom database engine backend for OpenBSD, we are now able to support OpenBSD again. We added a CI step to get early warnings if we introduce something that breaks support.

What's Changed

• feat: new migration system by @fmartingr in #876
• chore(deps): bump the all group across 1 directory with 4 updates by @dependabot in #895
• refactor: allow specific sqlite engine for OpenBSD by @pacoesteban in #780
• chore(deps): bump the all group across 1 directory with 4 updates by @dependabot in #900
• chore(deps): bump the all group with 4 updates by @dependabot in #902
• fix: not checking for nil-pointer errors on migrations by @fmartingr in #906
• ci: unify local and ci docker workflows by @fmartingr in #907
• fix: ensure tmp folder is present on docker container by @fmartingr in #910
• deps: update golang dependencies by @fmartingr in #915
• chore(deps): bump the all group with 3 updates by @dependabot in #908
• chore(deps): bump the all group with 2 updates by @dependabot in #917
• feat: Home button clear search query by @Monirzadeh in #916
• chore(deps): bump codecov/codecov-action from 4.4.0 to 4.4.1 in the all group by @dependabot in #922
• chore: check for avx2 processor feature when trying to run bun by @Monirzadeh in #920
• ci: fix codecov action by @fmartingr in #928
• fix: incorrect original link in archive page by @fmartingr in #931
• fix : wrong response type for readable endpoint documentation by @Monirzadeh in #932
• feat: allow selecting light/dark/follow themes in the webui by @Monirzadeh in #924
• fix: add version to goreleaser archive filename by @fmartingr in #934

New Contributors

• @pacoesteban made their first contribution in #780

Full Changelog: v1.6.3...v1.7.0

Changelog

Features

• 2a231ec feat: allow selecting light/dark/follow themes in the webui (#924)

Fixes

• a1d7579 fix: incorrect original link in archive page (#931)
• 47a0143 fix: swagger document response type (#932)

CI and Delivery

• d05188b ci: fix codecov action issues (#928)

Changelog

Features

• 6c94d56 feat: Home button clear search query (#916)

Others

• 75395c6 chore: check for avx2 processor feature when trying to run bun (#920)

Changelog

Features

• 31767f7 feat: new migrations system (#876)

Fixes

• eaa6f0e fix(sqlite): id column should be unique (#894)
• 4de4799 fix: ensure tmp folder is present on docker container (#910)
• a6e5570 fix: not checking for nil-pointer errors on migrations (#906)

CI and Delivery

• 647945c ci: unify local and ci docker workflows (#907)

Others

• 02247b2 refactor: allow specific sqlite engine for OpenBSD (#780)

Changelog

Features

• b8a3578 feat: api endpoint to serve readable content (#885)

Fixes

• 6254f77 fix(ci): prevent tagging docker image as latest on every push (#882)
• c77a542 fix(ci): renamed deprecated golangci property (#887)
• db313f5 fix: authentication flow should abort early (#888)

Documentation

• 9bf3dae docs: add PikaPods managed hosting option (#881)

CI and Delivery

• 394d17b ci: create zip archives for windows builds (#884)
• d358b7f ci: replace deprecated --rm-dist with clean (#878)

Changelog

Fixes

• 48db805 fix: remove unfinished endpoints (#877)
• ceb392d fix: use relative path for all API calls (#872)

Changelog

Fixes

• 47e7259 fix(ci): use correct tag names on version bump (#864) by @fmartingr
• 9c7483f fix: override configuration from flags only if set (#865) by @fmartingr
• 5a16690 fix: use correct endpoint in rename tags operation (#868) by @Zlendy

Documentation

• 21c95ac docs: Add securityContext to provided Kubernetes manifest (#859) @piano1029

Others

• ce04b10 chore: updated github issue template (#672) by @fmartingr

New Contributors

• @piano1029 made their first contribution in #859
• @Zlendy made their first contribution in #868

Full Changelog: v1.6.0...v1.6.1

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

• APIv1: Start working on new REST API. Refactor logic in domains. by @fmartingr in #497
• Run legacy API and new API at the same time. by @fmartingr in #648
• fix: docker buildx tags by @fmartingr in #650
• Allow JWT authentication into legacy APIs by @fmartingr in #651
• Show version in login page by @fmartingr in #652
• fix: package-name in cleanup tag by @fmartingr in #655
• fix: pr tag prune using other action by @fmartingr in #656
• fix: title is never retrieved when adding bookmark by @fmartingr in #664
• Show Shiori version on server command by @fmartingr in #669
• chore: remove irc badge from README by @fmartingr in #674
• fix: title overwritten if user has defined it by @fmartingr in #684
• Proper SQLite default database and warn SHIORI_DBMS users by @fmartingr in #667
• chore: remove verbose logger by @fmartingr in #685
• Fix CI incorrectly tagging RC releases and disables docker builds on forks by @fmartingr in #686
• preserve fragment in URLs (#315) by @arakimo in #687
• Swagger improvements by @fmartingr in #666
• fix: Ensure bookmark files are correctly downloaded before deleting current ones by @Monirzadeh in #683
• fix(db): handle usage of special characters in searches by @fmartingr in #721
• fix: properly parse mysql connection string, docs update by @rutkai in #730
• deps: upgrade to Go 1.21 by @fmartingr in #698
• deps: upgrade github.com/gofrs/uuid to v5 by @Monirzadeh in #736
• feat: build css from less files locally by @fmartingr in #735
• refactor: Migrate ePub generation to go-epub by @Monirzadeh in #679
• chore(deps): bump the all group with 6 updates by @dependabot in #738
• chore(deps): bump the all group with 1 update by @dependabot in #740
• feat: use new JWT auth in all frontend API calls by @fmartingr in #743
• chore(deps): bump the all group with 1 update by @dependabot in #746
• fix: styles-check and swag-check monitor just needed directory not project root by @Monirzadeh in #747
• feat: allow resize the dialogbox for bigger/hidpi screens by @Monirzadeh in #732
• feat: allow per-user settings and store them in database by @Monirzadeh in #639
• fix: Remove unneeded variable and unify the way send token in header by @Monirzadeh in #763
• add create ebook by default in settings by @Monirzadeh in #761
• fix: Actions in overlays on mobile hard to press by @cbe in #759
• fix: Use webp as thumbnail by @Monirzadeh in #758
• Update documentation for add links to shiori in android devices from share menu by @Monirzadeh in #757
• Fix typos by @shirayu in #756
• chore(deps): bump the all group with 1 update by @dependabot in #767
• refactor: migrate ebook routes by @Monirzadeh in #742
• Make suggestions tapable/clickable by @cbe in #765
• chore: frontend formatting by @cbe in #764
• ci: add codecov reporting by @fmartingr in #776
• deps: update go dependencies by @fmartingr in #777
• fix typo by @Monirzadeh in #778
• docs: example deployment for kubernetes by @JPFrancoia in #754
• Add Documentation>CLI>Add bookmark by @LLKoder in #794
• fix: generate coverage profile by @fmartingr in #797
• fix: use noreferer to prevent exposing shiori instance url to archived websites by @istiak101 in #802
• deps: upgrade by @fmartingr in #804
• refactor: migrate bookmark static pages to new http server by @fmartingr in #775
• Fixed lint errors after refactor by @fmartingr in #806
• docs: updated configuration page by @fmartingr in #808
• fix: force usage of shiori prefix for environment variables in configuration by @fmartingr in #807
• deps: updated docker image versions by @fmartingr in #809
• chore(deps): bump the all group with 3 updates by @dependabot in #812
• chore(deps): bump the all group with 3 updates by @dependabot in #815
• chore(deps): bump the all group with 3 updates by @dependabot in #830
• fix: fixes path issues on windows by @Monirzadeh in #829
• fix: regressions and documentation from 1.5.5 upgrade by @fmartingr in #837
• fix: update go-epub to latest version to avoid filename errors on windows by @fmartingr in #840
• fix: point go-epub go correct repository by @fmartingr in #842
• feat: allow authentication using proxy request header by @PterX in #836

New Contributors

• @arakimo made their first contribution in #687
• @rutkai made their first contribution in #730
• @cbe made their first contribution in #759
• @shirayu made their first contribution in #756
• @JPFrancoia made their first contribution in htt...

Changelog

• 84e5b09 chore(deps): bump the all group with 3 updates (#815)
• 15b2a1e chore(deps): bump the all group with 3 updates (#830)
• 0c876bc chore(deps): update ci dependencies (#812)
• 82aa1e5 fix: fixes path issues on windows (#829)

Changelog

• f72e2de deps: updated docker image versions (#809)
• 7c13626 fix: strict usage of shiori prefix for environment variables in configuration (#807)