add v2.2.7 release notes

centrifugal · Dec 3, 2019 · 134f213 · 134f213
1 parent 7656e91
commit 134f213
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+v2.2.7
+======
+
+Improvements:
+
+* Support passing `api_key` over URL param, see [#317](https://github.com/centrifugal/centrifugo/issues/317) for reasoning behind this feature
+
 v2.2.6
 ======
 

diff --git a/docs/content/server/http_api.md b/docs/content/server/http_api.md
@@ -27,6 +27,8 @@ This API key must be set in request `Authorization` header in this way:
 Authorization: apikey <KEY>
 ```
 
+Starting from Centrifugo v2.2.7 it's also possible to pass API key over URL query param. This solves some edge cases where it's not possible to use `Authorization` header. Simply add `?api_key=<YOUR API KEY>` query param to API endpoint. Keep in mind that passing API key in `Authorization` header is a recommended way. 
+
 It's possible to disable API key check on Centrifugo side using `api_insecure` configuration option. Be sure to protect API endpoint by firewall rules in this case to prevent anyone in internet to send commands over your unprotected Centrifugo API. API key auth is not very safe for man-in-the-middle so recommended way is running Centrifugo with TLS (we are in 2018 in the end).
 
 Command is a JSON object with two properties: `method` and `params`.

diff --git a/misc/release/notes.md b/misc/release/notes.md
@@ -1 +1,3 @@
-This is a quick fix release. Fixes an error on start when `namespaces` not set in configuration file,the bug was introduced in v2.2.5, see [#319](https://github.com/centrifugal/centrifugo/issues/319) for details.
+Improvements:
+
+* Support passing `api_key` over URL param, see [#317](https://github.com/centrifugal/centrifugo/issues/317) for reasoning behind this feature