Skip to content
This repository was archived by the owner on Oct 20, 2024. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
babelouest committed Aug 24, 2020
1 parent c9f8b13 commit 675f5e4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The backend API server is fully written in C and uses a small amount of resource

Its plugin architecture makes it easy to add new modules or plugins, or modify existing ones with less risks to have unmaintainable code.

Glewlwyd 2.3 [is released](https://github.com/babelouest/glewlwyd/releases/tag/v2.3.0). Feel free to [install](docs/INSTALL.md), test it, and [send feedbacks](https://github.com/babelouest/glewlwyd/issues) if you feel like it.
Glewlwyd 2.3.3 [is released](https://github.com/babelouest/glewlwyd/releases/tag/v2.3.3). Feel free to [install](docs/INSTALL.md), test it, and [send feedbacks](https://github.com/babelouest/glewlwyd/issues) if you feel like it. If you upgrade an existing Glewlwyd instance, please follow the security guidelines in the [Install documentation](https://github.com/babelouest/glewlwyd/blob/2.3/docs/INSTALL.md#upgrade-to-glewlwyd-233)

Important! Due to a complete database reworking of the application, you can't upgrade an existing installation from Glewlwyd 1.x to Glewlwyd 2.x.

Expand Down
10 changes: 10 additions & 0 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Installation

1. [Upgrade Glewlwyd](#upgrade-glewlwyid)
* [Upgrade to Glewlwyd 2.3.3](#upgrade-to-glewlwyd-233)
* [Upgrade to Glewlwyd 2.3.x](#upgrade-to-glewlwyd-23x)
* [Upgrade to Glewlwyd 2.2.x](#upgrade-to-glewlwyd-22x)
* [Upgrade to Glewlwyd 2.1.x](#upgrade-to-glewlwyd-21x)
Expand Down Expand Up @@ -49,6 +50,15 @@

Glewlwyd upgrades usually come with database changes. It is highly recommended to backup your database before performing the upgrade. You must perform the database upgrades in the correct order. i.e. if you upgrade from Glewlwyd 2.1 to Glewlwyd 2.3, you must first install the 2.2 upgrade, then the 2.3.

### Upgrade to Glewlwyd 2.3.3

This is a security release, please upgrade your Glewlwyd version.
To mitigate server configuration leaks, I recommend the following actions:
- If you use the TLS Certificate Scheme with [Allow to emit PKCS#12 certificates for the clients](https://github.com/babelouest/glewlwyd/blob/2.3/docs/CERTIFICATE.md#allow-to-emit-pkcs12-certificates-for-the-clients) enabled, please revoke the issuer certificate and use new ones
- If you use the Webauthn Scheme, it's reommended to regenerate the [Random seed used to mitigate intrusion](https://github.com/babelouest/glewlwyd/blob/2.3/docs/WEBAUTHN.md#random-seed-used-to-mitigate-intrusion)
- If you use the Oauth2 Scheme, please change the [clients secrets](https://github.com/babelouest/glewlwyd/blob/2.3/docs/OAUTH2_SCHEME.md#secret)
- If yout use the Email code scheme and use a [SMTP password](https://github.com/babelouest/glewlwyd/blob/2.3/docs/EMAIL.md#smtp-password-if-required), please to change this password

### Upgrade to Glewlwyd 2.3.x

#### Mandatory core tables upgrade
Expand Down

0 comments on commit 675f5e4

Please sign in to comment.