Skip to content

Commit

Permalink
Release page with authentication information, stressing the need to r…
Browse files Browse the repository at this point in the history
…e-authenticate every time the application opens
  • Loading branch information
mvriel committed Sep 18, 2024
1 parent 6087735 commit 139c7f8
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
12 changes: 11 additions & 1 deletion docs/docs/developers/features/layers-with-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,17 @@ file. This is because authentication status is a **temporary state** that should
a project is loaded, the authentication process must be reinitiated for protected layers, ensuring that credentials are
entered securely and as needed.

## 7. Warnings and User Flow
## 7. Need to re-authenticate reopening the application

A key implication of this design is that users will need to re-authenticate any protected layers every time they reopen
the application or load a saved project file. Since credentials are never stored in the project file for security
reasons, the system requires users to provide valid credentials again when the project is reloaded.

This approach ensures that sensitive credentials are handled securely, but it also means that re-authentication is
necessary whenever a protected layer is accessed in a new session. Users should be aware that any protected layers will
initially be in a non-visible state until the required credentials are provided.

## 8. Warnings and User Flow

The current user flow for managing layer authentication includes:

Expand Down
2 changes: 1 addition & 1 deletion docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.md-typeset h2 {
margin-top: 3.2rem;
margin-top: 2rem;
}

/*****************************************************************************/
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ nav:
- 'docs/developers/features/embedding.md'
- 'docs/developers/features/floating-origin.md'
- 'docs/developers/features/layers.md'
- 'docs/developers/features/layers-with-authentication.md'
- 'docs/developers/features/geojson.md'
- 'Packages':
- 'docs/developers/packages/index.md'
Expand Down Expand Up @@ -55,7 +56,6 @@ not_in_nav: |
_*.md
docs/developers/core-concepts.md
docs/developers/projects.md
docs/developers/features/layers-with-authentication.md
site_name: "" # Empty on purpose for style purposes
theme:
Expand Down

0 comments on commit 139c7f8

Please sign in to comment.