Skip to content

Commit

Permalink
experimenting with github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mmguero committed Sep 23, 2022
1 parent e6f4471 commit 811a35d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ anomaly_detection_docs_uri: docs/anomaly-detection.html
api_docs_uri: docs/api.html
arkime_docs_uri: docs/arkime.html
components_docs_uri: docs/components.html
configuring_docs_uri: docs/malcolm-config.html
configuring_docs_uri: docs/malcolm-preparation.html
contributing_docs_uri: docs/contributing-guide.html
dashboards_docs_uri: docs/dashboards.html
hardening_docs_uri: docs/hardening.html
Expand Down
13 changes: 13 additions & 0 deletions docs/running.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
## <a name="Running"></a>Running Malcolm

* [Running Malcolm](#Running)
* [OpenSearch instances](opensearch-instances.md#OpenSearchInstance)
* [Authentication and authorization for remote OpenSearch clusters](opensearch-instances.md#OpenSearchAuth)
* [Configure authentication](authsetup.md#AuthSetup)
* [Local account management](authsetup.md#AuthBasicAccountManagement)
* [Lightweight Directory Access Protocol (LDAP) authentication](authsetup.md#AuthLDAP)
- [LDAP connection security](authsetup.md#AuthLDAPSecurity)
* [TLS certificates](authsetup.md#TLSCerts)
* [Starting Malcolm](#Starting)
* [Stopping and restarting Malcolm](#StopAndRestart)
* [Clearing Malcolm's data](#Wipe)
* [Temporary read-only interface](#ReadOnlyUI)

### <a name="Starting"></a>Starting Malcolm

[Docker compose](https://docs.docker.com/compose/) is used to coordinate running the Docker containers. To start Malcolm, navigate to the directory containing `docker-compose.yml` and run:
Expand Down
4 changes: 4 additions & 0 deletions docs/upload.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## <a name="Upload"></a>Capture file and log archive upload

* [Capture file and log archive upload](#Upload)
- [Tagging](#Tagging)
- [Processing uploaded PCAPs with Zeek and Suricata](#UploadPCAPProcessors)

Malcolm serves a web browser-based upload form for uploading PCAP files and Zeek logs at [https://localhost/upload/](https://localhost/upload/) if you are connecting locally.

![Capture File and Log Archive Upload](./images/screenshots/malcolm_upload.png)
Expand Down

0 comments on commit 811a35d

Please sign in to comment.