diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md index b19963d..407841c 100644 --- a/docs/docs/CHANGELOG.md +++ b/docs/docs/CHANGELOG.md @@ -13,12 +13,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 -### Added - -Anubis now supports these new languages: - -- [Italian](https://github.com/TecharoHQ/anubis/pull/778) - ## v1.21.0: Minfilia Warde > Please, be at ease. You are among friends here. @@ -40,11 +34,16 @@ Anubis now is able to store things persistently [in memory](./admin/policies.mdx Anubis now supports localized responses. Locales can be added in [lib/localization/locales/](https://github.com/TecharoHQ/anubis/tree/main/lib/localization/locales). This release includes support for the following languages: - [Brazilian Portugese](https://github.com/TecharoHQ/anubis/pull/726) +- [Chinese (Simplified)](https://github.com/TecharoHQ/anubis/pull/774) - [Chinese (Traditional)](https://github.com/TecharoHQ/anubis/pull/759) - English - [Estonian](https://github.com/TecharoHQ/anubis/pull/783) +- [Filipino](https://github.com/TecharoHQ/anubis/pull/775) - [French](https://github.com/TecharoHQ/anubis/pull/716) - [German](https://github.com/TecharoHQ/anubis/pull/741) +- [Icelandic](https://github.com/TecharoHQ/anubis/pull/780) +- [Italian](https://github.com/TecharoHQ/anubis/pull/778) +- [Japanese](https://github.com/TecharoHQ/anubis/pull/772) - [Spanish](https://github.com/TecharoHQ/anubis/pull/716) - [Turkish](https://github.com/TecharoHQ/anubis/pull/751) @@ -103,6 +102,18 @@ There are a bunch of other assorted features and fixes too: ### Potentially breaking changes +We try to introduce breaking changes as much as possible, but these are the changes that may be relevant for you as an administrator: + +#### Challenge format change + +Previously Anubis did no accounting for challenges that it issued. This means that if Anubis restarted during a client, the client would be able to proceed once Anubis came back online. + +During the upgrade to v1.21.0 and when v1.21.0 (or later) restarts with the [in-memory storage backend](./admin/policies.mdx#memory), you may see a higher rate of failed challenges than normal. If this persists beyond a few minutes, [open an issue](https://github.com/TecharoHQ/anubis/issues/new). + +If you are using the in-memory storage backend, please consider using [a different storage backend](./admin/policies.mdx#storage-backends). + +#### Systemd service changes + The following potentially breaking change applies to native installs with systemd only: Each instance of systemd service template now has a unique `RuntimeDirectory`, as opposed to each instance of the service sharing a `RuntimeDirectory`. This change was made to avoid [the `RuntimeDirectory` getting nuked any time one of the Anubis instances restarts](https://github.com/TecharoHQ/anubis/issues/748). diff --git a/docs/docs/admin/policies.mdx b/docs/docs/admin/policies.mdx index 7badcb2..bda0372 100644 --- a/docs/docs/admin/policies.mdx +++ b/docs/docs/admin/policies.mdx @@ -268,6 +268,12 @@ The memory backend is an in-memory cache. This backend works best if you don't u The biggest downside is that there is not currently a limit to how much data can be stored in memory. This will be addressed at a later time. +:::warning + +The in-memory backend exists mostly for validation, testing, and to ensure that the default configuration of Anubis works as expected. Do not use this persistently in production. + +::: + #### Configuration The memory backend does not require any configuration to use.