From 3f123cd69e1869412ceed9b24a235e6f407f0faf Mon Sep 17 00:00:00 2001 From: mikestefanello Date: Tue, 4 Jan 2022 20:10:10 -0500 Subject: [PATCH] Added encryption info to README. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e10875d..24c45ed 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ * [Entity types](#entity-types) * [New entity type](#new-entity-type) * [Sessions](#sessions) + * [Encryption](#encryption) * [Authentication](#authentication) * [Login / Logout](#login--logout) * [Forgot password](#forgot-password) @@ -295,6 +296,10 @@ func SomeFunction(ctx echo.Context) error { } ``` +### Encryption + +Session data is encrypted for security purposes. The encryption key is stored in [configuration](#configuration) at `Config.App.EncryptionKey`. While the default is fine for local development, it is **imperative** that you change this value for any live environment otherwise session data can be compromised. + ## Authentication Included are standard authentication features you expect in any web application. Authentication functionality is bundled as a _Service_ within `services/AuthClient` and added to the `Container`. If you wish to handle authentication in a different manner, you could swap this client out or modify it as needed. @@ -769,7 +774,7 @@ if page.HTMX.Request.Target == "search" { ``` ```go -{{if eq .page.HTMX.Request.Target "search"}} +{{if eq .HTMX.Request.Target "search"}} // Render content for the #search element {{end}} ```