Skip to content

Commit

Permalink
Merge pull request #433 from piercema/logout_page
Browse files Browse the repository at this point in the history
Logout page
  • Loading branch information
piercema authored Feb 29, 2024
2 parents b95dd3f + 8cf645f commit 7ac774f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Malcolm can also easily be deployed locally on an ordinary consumer workstation
* [LDAP connection security](authsetup.md#AuthLDAPSecurity)
+ [TLS certificates](authsetup.md#TLSCerts)
+ [Command-line arguments](authsetup.md#CommandLineConfig)
- [Log Out of Malcolm](authsetup.md#LoggingOut)
- [Platform-specific Configuration](host-config.md#HostSystemConfig)
+ [Linux host system configuration](host-config-linux.md#HostSystemConfigLinux)
+ [macOS host system configuration](host-config-macos.md#HostSystemConfigMac)
Expand Down Expand Up @@ -85,7 +86,7 @@ Malcolm can also easily be deployed locally on an ordinary consumer workstation
+ [Other Customizations](custom-rules.md#Other)
- [Automatic file extraction and scanning](file-scanning.md#ZeekFileExtraction)
+ [User interface](file-scanning.md#ZeekFileExtractionUI)
- [Index management](index-management.md#
- [Index management](index-management.md#)
+ [OpenSearch index management](index-management.md#OpenSearchIndexManagement)
+ [Using ILM/ISM with Arkime](index-management.md#ArkimeIndexPolicies)
- [Event severity scoring](severity.md#Severity)
Expand Down
7 changes: 7 additions & 0 deletions docs/authsetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
+ [LDAP connection security](#AuthLDAPSecurity)
- [TLS certificates](#TLSCerts)
- [Command-line arguments](#CommandLineConfig)
* [Log Out of Malcolm](#LoggingOut)

Malcolm requires authentication to access the [user interface](quickstart.md#UserInterfaceURLs). [Nginx](https://nginx.org/) can authenticate users with either local TLS-encrypted HTTP basic authentication or a remote Lightweight Directory Access Protocol (LDAP) authentication server.

Expand Down Expand Up @@ -146,3 +147,9 @@ Authentication Setup:
```

In order to avoid specifying passwords as command line arguments, when setting the administrator password noninteractively the user must instead provide hashes generated by [`openssl -passwd -1`](https://www.openssl.org/docs/man1.1.1/man1/openssl-passwd.html) and [`htpasswd -n -B username`](https://httpd.apache.org/docs/2.4/programs/htpasswd.html).

# <a name="LoggingOut"></a>Log Out of Malcolm

Since Malcolm's nginx reverse proxy uses HTTP Basic Authentication, there is no "Logout" button. Users should exit their browser window to log out of Malcom. On the next browser restart, Malcolm will prompt the user for credentials.

Another way to log out of Malcolm is for a user to manually clear their browser's active sessions.

0 comments on commit 7ac774f

Please sign in to comment.