Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add doc policies #22

Merged
merged 1 commit into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/administration/img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/administration/img_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 38 additions & 2 deletions docs/administration/policies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# Policies

!!! tip "Under construction"
## Overview

We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenBAS-Platform/docs).
The Policies configuration page, located under **Settings > Security > Policies**, is designed to manage and customize various security-related settings.
This page currently includes the configuration of _login messages_, with plans to expand its capabilities in the future.

### Current Features

**Login Messages**
Administrators can create and manage messages that are displayed to users upon login. This feature is useful for providing important information or updates directly to users when they access the platform.
There are three types of messages:
* **Platform Login Message**: Displayed above the login form to communicate vital information or announcements.
* **Platform Consent Message**: Displayed to users during the login process. It appears as a notification that blocks access to the login form until users actively give their consent by checking an approval box. This ensures that users acknowledge and agree to certain terms or conditions before proceeding with logging in.
* **Platform Consent Confirm Text**: A message accompanying the consent box, providing clarity on the consent confirmation process.

These messages can be customized to fit the organization's specific needs and requirements, ensuring that critical information is communicated effectively to users.
<p align="center">
<img src="img.png" width="350">
</p>
<p align="center">
<img src="img_1.png" width="350">
</p>

### Accessing the Policies Configuration Page

To access the Policies configuration page, navigate to:

Settings / Security / Policies

### How to Configure Login Messages

1. Navigate to the Policies Configuration Page: Go to "Settings > Security > Policies".
2. Login Messages Section: Locate the section for login messages.
3. Enter Message Details: Provide the content for the login message.
4. Save Changes: Save your changes to apply the new or updated message.

### Best Practices

* Regular Updates: Regularly update login messages to keep users informed of any critical updates or changes.
* Clear Communication: Ensure that messages are clear and concise to avoid confusion.