diff --git a/arkime/patch/footer_links.patch b/arkime/patch/footer_links.patch index b89cf4e4d..aaf2635af 100644 --- a/arkime/patch/footer_links.patch +++ b/arkime/patch/footer_links.patch @@ -8,7 +8,7 @@ index 50e30c99..d67dfb36 100644 Arkime v{{molochVersion}} | - arkime.com + arkime.com 🦉 -+ | Malc⦿lm 📄 ++ | Malc⦿lm 📄 + | Dashboards 📊 - | {{ responseTime | commaString }}ms diff --git a/docs/development.md b/docs/development.md index d3dc07ddb..bf0a46e8c 100644 --- a/docs/development.md +++ b/docs/development.md @@ -135,7 +135,8 @@ A minute or so after starting Malcolm, the following services will be accessible - PCAP upload (sftp): sftp://USERNAME@127.0.0.1:8022/files/ - Host and subnet name mapping editor: https://localhost/name-map-ui/ - NetBox: https://localhost/netbox/ - - Account management: https://localhost:488/ + - Account management: https://localhost:488/ + - Documentation: https://localhost/readme/ ``` The above example will result in the following artifacts for distribution as explained in the script's output: diff --git a/docs/ubuntu-install-example.md b/docs/ubuntu-install-example.md index 9601bef8a..718fdaa10 100644 --- a/docs/ubuntu-install-example.md +++ b/docs/ubuntu-install-example.md @@ -285,6 +285,7 @@ In a few minutes, Malcolm services will be accessible via the following URLs: - Host and subnet name mapping editor: https://localhost/name-map-ui/ - NetBox: https://localhost/netbox/ - Account management: https://localhost:488/ + - Documentation: https://localhost/readme/ NAME COMMAND SERVICE STATUS PORTS malcolm-api-1 "/usr/local/bin/dock…" api running (starting) … diff --git a/scripts/control.py b/scripts/control.py index 913da742f..c3dc3a595 100755 --- a/scripts/control.py +++ b/scripts/control.py @@ -606,6 +606,7 @@ def start(): eprint(" - Host and subnet name mapping editor: https://localhost/name-map-ui/") eprint(" - NetBox: https://localhost/netbox/\n") eprint(" - Account management: https://localhost:488/\n") + eprint(" - Documentation: https://localhost/readme/\n") else: eprint("Malcolm failed to start\n") eprint("\n".join(out)) diff --git a/scripts/malcolm_appliance_packager.sh b/scripts/malcolm_appliance_packager.sh index d80c5cf5e..fb53a03ca 100755 --- a/scripts/malcolm_appliance_packager.sh +++ b/scripts/malcolm_appliance_packager.sh @@ -119,8 +119,6 @@ if mkdir "$DESTDIR"; then pushd .. >/dev/null 2>&1 DESTNAME="$RUN_PATH/$(basename $DESTDIR).tar.gz" README="$RUN_PATH/$(basename $DESTDIR).README.txt" - README_HTML="$RUN_PATH/$(basename $DESTDIR).README.html" - docker run --rm --entrypoint /bin/bash "$(grep -E 'image: *malcolmnetsec/arkime' "$DESTDIR/docker-compose.yml" | awk '{print $2}')" -c "cat /opt/arkime/doc/README.html" > "$README_HTML" || true cp $VERBOSE "$SCRIPT_PATH/install.py" "$RUN_PATH/" cp $VERBOSE "$SCRIPT_PATH/malcolm_common.py" "$RUN_PATH/" tar -czf $VERBOSE "$DESTNAME" "./$(basename $DESTDIR)/" @@ -161,6 +159,7 @@ if mkdir "$DESTDIR"; then echo " - Host and subnet name mapping editor: https://localhost/name-map-ui/" | tee -a "$README" echo " - NetBox: https://localhost/netbox/" | tee -a "$README" echo " - Account management: https://localhost:488/" | tee -a "$README" + echo " - Documentation: https://localhost/readme/" | tee -a "$README" popd >/dev/null 2>&1 popd >/dev/null 2>&1 popd >/dev/null 2>&1 diff --git a/shared/bin/service_check_passthrough.sh b/shared/bin/service_check_passthrough.sh index 013f52cf5..7c7fb6bcd 100755 --- a/shared/bin/service_check_passthrough.sh +++ b/shared/bin/service_check_passthrough.sh @@ -149,7 +149,7 @@ EOF
$SERVICE Disabled

The local service $SERVICE has been disabled.

-

Refer to the Malcolm documentation.

+

Refer to the Malcolm documentation.

EOF