diff --git a/docs/README.md b/docs/README.md index 6883a6d8f..2d2f14741 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) @@ -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) diff --git a/docs/authsetup.md b/docs/authsetup.md index 49b707643..19100a8cc 100644 --- a/docs/authsetup.md +++ b/docs/authsetup.md @@ -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. @@ -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). + +# 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.