Added encryption info to README.

This commit is contained in:
mikestefanello 2022-01-04 20:10:10 -05:00
parent c391be9e4d
commit eda79b6982

View File

@ -33,6 +33,7 @@
* [Entity types](#entity-types) * [Entity types](#entity-types)
* [New entity type](#new-entity-type) * [New entity type](#new-entity-type)
* [Sessions](#sessions) * [Sessions](#sessions)
* [Encryption](#encryption)
* [Authentication](#authentication) * [Authentication](#authentication)
* [Login / Logout](#login--logout) * [Login / Logout](#login--logout)
* [Forgot password](#forgot-password) * [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 ## 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. 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 ```go
{{if eq .page.HTMX.Request.Target "search"}} {{if eq .HTMX.Request.Target "search"}}
// Render content for the #search element // Render content for the #search element
{{end}} {{end}}
``` ```