Add search and UX improvements

MobSF · Nov 11, 2024 · 98c019b · 98c019b
1 parent 390f4fe
commit 98c019b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Mobile Security Framework (MobSF) is an automated, all-in-one mobile application
 
 [![Donate to MobSF](https://user-images.githubusercontent.com/4301109/117404264-7aab5480-aebe-11eb-9cbd-da82d7346bb3.png)](https://opensecurity.in/donate)
 
-If you find MobSF useful, please consider donating to support its development.
+> Has MobSF made a difference for you? Show your support and help us innovate with a donation. It's easy to build open source, maintaining one is a different story.
 
 ---
 

diff --git a/docker_options.md b/docker_options.md
@@ -1,5 +1,6 @@
 # Docker Options
 
+## Docker
 #### Prebuilt Docker image from DockerHub
 
 ```bash
@@ -43,7 +44,7 @@ docker build --no-cache --rm -t mobsf .
 ```bash
 docker logs -f --tail 100 mobsf
 ```
-
+## Docker Compose
 #### For Postgres and Nginx reverse proxy support
 
 ```bash

diff --git a/index.html b/index.html
@@ -20,31 +20,29 @@
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/theme-simple-dark.css">
   <!-- Google Font Link for Merriweather -->
   <link href="https://fonts.googleapis.com/css2?family=Merriweather:wght@300;400;700&display=swap" rel="stylesheet">
-   <style>
-      /* Optional: Custom styling for the translate element */
-      #google_translate_element {
+  <style>
+     /* Optional: Custom styling for the translate element */
+     #google_translate_element {
         margin: 10px 0;
-      }
+     }
      /* Apply Merriweather font with Arial and sans-serif as fallbacks */
      body {
        font-family: 'Merriweather', 'Libre Baskerville', Arial, sans-serif;
        font-size: 18px;
        line-height: 1.6;
      }
-
      /* Optional: Style headers */
      h1, h2, h3, h4, h5, h6 {
        font-weight: 700;
        color: #222;
      }
-
      /* Style the markdown section for padding and spacing */
      .markdown-section {
        max-width: 65%;
        margin: auto;
        padding: 15px;
      }
-   </style>
+  </style>
 </head>
 <body>
   <div id="app">
@@ -57,6 +55,13 @@
       loadSidebar: true,
       loadNavbar: true,
       subMaxLevel: 2,
+      search: {
+        maxAge: 86400000, // Expiration time in milliseconds (default: 1 day)
+        paths: 'auto',    // Paths to be indexed (default: 'auto')
+        placeholder: 'Type to search',
+        noData: 'No Results!',
+        depth: 2,         // Headline depth to be indexed (default: 2)
+      },
     }
     // Google Tag Manager
     window.dataLayer = window.dataLayer || [];
@@ -69,6 +74,15 @@
           {pageLanguage: 'en'},
           'google_translate_element');
     }
+    // Check if the URL has a query parameter named 'id'
+    window.addEventListener('hashchange', () => {
+      const urlParams = new URLSearchParams(window.location.search);
+      if (!urlParams.has('id')) {
+        // Scroll to the top if 'id' parameter is not present
+        window.scrollTo(0, 0);
+      }
+    });
+
   </script>
   <script async="" src="https://www.googletagmanager.com/gtag/js?id=UA-160159852-1"></script>
   <script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
@@ -78,6 +92,7 @@
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-batch.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-python.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
   <script src="//unpkg.com/mermaid/dist/mermaid.js"></script>
   <script src="//unpkg.com/docsify-mermaid@latest/dist/docsify-mermaid.js"></script>
   <script>

diff --git a/running_mobsf_docker.md b/running_mobsf_docker.md
@@ -4,6 +4,8 @@
 
 To ensure you have the latest features, security updates, and bug fixes, it's best to download the most recent `latest` tagged MobSF Docker image. We also provide versioned [releases](https://hub.docker.com/r/opensecurity/mobile-security-framework-mobsf/tags), though they may not include the latest updates.
 
+## Static Analysis
+
 ### Run MobSF with Static Analysis Support
 
 Download the latest docker image and run the MobSF container.
@@ -17,6 +19,7 @@ docker run -it --rm \
 
 You can now access the MobSF web interface by opening `http://127.0.0.1:8000` in your browser. Use the default login credentials: `mobsf/mobsf`.
 
+## Dynamic Analysis
 ### Run MobSF with Static & Dynamic Analysis Support
 
 You must run any of the **[supported](dynamic_analyzer_docker.md)** (Genymotion Android VM/ Android Studio Emulator/ Corellium VM) and obtain the `MOBSF_ANALYZER_IDENTIFIER` before running MobSF.
@@ -73,7 +76,7 @@ docker run -it --rm \
     opensecurity/mobile-security-framework-mobsf:latest
 ```
 
-## How to use MobSF
+## MobSF Tutorials
 
 This video from Defcon Demo Labs 2020 explains some of the basic features of MobSF.
-Original file line number
+Diff line change
@@ Expand Up @@
     [![Donate to MobSF](https://user-images.githubusercontent.com/4301109/117404264-7aab5480-aebe-11eb-9cbd-da82d7346bb3.png)](https://opensecurity.in/donate)
-    If you find MobSF useful, please consider donating to support its development.
+    > Has MobSF made a difference for you? Show your support and help us innovate with a donation. It's easy to build open source, maintaining one is a different story.
     ---
@@ Expand Down @@