summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAndrew Godwin2022-12-15 15:57:29 -0700
committerAndrew Godwin2022-12-15 15:57:29 -0700
commitf55a00ecef6d9b4047ea483df881eff9066370bf (patch)
tree88416b24a019e657efd67e383903df6d07e8ae08 /docs
parent9ad9bdd9363dedf50ab3fbe70375bd817f92512b (diff)
downloadtakahe-f55a00ecef6d9b4047ea483df881eff9066370bf.tar.gz
takahe-f55a00ecef6d9b4047ea483df881eff9066370bf.tar.bz2
takahe-f55a00ecef6d9b4047ea483df881eff9066370bf.zip
Start documenting 0.6 changes
Diffstat (limited to 'docs')
-rw-r--r--docs/installation.rst10
-rw-r--r--docs/releases/0.6.rst40
2 files changed, 41 insertions, 9 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index f8b8937..3fdda0d 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -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
###############
diff --git a/docs/releases/0.6.rst b/docs/releases/0.6.rst
new file mode 100644
index 0000000..c805c8d
--- /dev/null
+++ b/docs/releases/0.6.rst
@@ -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