Start documenting 0.6 changes

This commit is contained in:
Andrew Godwin 2022-12-15 15:57:29 -07:00
parent 9ad9bdd936
commit f55a00ecef
2 changed files with 41 additions and 9 deletions

View file

@ -142,22 +142,14 @@ Google Cloud Storage
To use GCS, provide a URL like:
* ``gcs://bucket-name``
* ``gs:///bucket-name``
The GCS backend currently only supports implicit authentication (from the
standard Google authentication environment variables, or machine roles).
Note that the bucket name only has two slashes before it - we will move this to
be three soon, like the S3 backend, but will notify you in release notes when
this changes and will allow the existing pattern to work for a while.
Your bucket must be set to world-readable and have individual object
permissions disabled.
* If it is set to ``s3://``, it must be in the form
``s3://access-key:secret-key@endpoint-url/bucket-name``. Your bucket must
permit publically-readable files to be uploaded.
Local Directory
###############

40
docs/releases/0.6.rst Normal file
View file

@ -0,0 +1,40 @@
0.6
===
*Not Yet Released*
This is a placeholder release note.
You can download images from `Docker Hub <https://hub.docker.com/r/jointakahe/takahe>`_,
or use the image name ``jointakahe/takahe:0.6``.
Upgrade Notes
-------------
Signed Cookie Sessions
~~~~~~~~~~~~~~~~~~~~~~
As of version 0.6, Takahē uses signed cookies for sessions rather than a
database table. As part of this change, when you upgrade, all users will be
signed out, but no data will be lost - they just need to sign in again.
Storage Settings
~~~~~~~~~~~~~~~~
If you use Google Cloud for storage, the URI format has changed - before it was
``gcs://bucketname``, and now it is ``gs:///bucketname``.
Migrations
~~~~~~~~~~
There are new database migrations, but for once, they are not fully
backwards-compatible, as we've deleted the unneeded ``stator_errors`` table.
To apply these migrations, you should:
* Stop all Stator processes (it's fine to leave webservers going)
* Apply the migrations
* Start new Stator processes