diff --git a/404.html b/404.html
index 549d557..89be2b5 100644
--- a/404.html
+++ b/404.html
@@ -6,6 +6,8 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
+        <meta name="description" content="CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses.">
+      
       
         <meta name="author" content="Nicolas Vuillamy">
       
@@ -432,7 +434,7 @@ <h1>404 - Not found</h1>
       <div class="md-copyright">
   
     <div class="md-copyright__highlight">
-      Copyright &copy; 2022 <a href="https://www.ox.security/?ref=codetotal" target= "_blank">OX Security</a>
+      Copyright &copy; 2023 <a href="https://www.ox.security/?ref=codetotal" target= "_blank">OX Security</a>
     </div>
   
   
diff --git a/CHANGELOG/index.html b/CHANGELOG/index.html
index 9c69850..7282d25 100644
--- a/CHANGELOG/index.html
+++ b/CHANGELOG/index.html
@@ -5,6 +5,7 @@
 <head>
 <meta charset="utf-8"/>
 <meta content="width=device-width,initial-scale=1" name="viewport"/>
+<meta content="CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="description"/>
 <meta content="Nicolas Vuillamy" name="author"/>
 <link href="https://codetotal.io/CHANGELOG/" rel="canonical"/>
 <link href="../license-explanations/" rel="prev"/>
@@ -22,7 +23,7 @@
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" name="twitter:image:src">
 <meta content="@nvuillam" name="twitter:site">
 <meta content="summary_large_image" name="twitter:card">
-<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title"/>
+<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title">
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:description"/>
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" property="og:image"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:image:alt"/>
@@ -31,7 +32,7 @@
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:title"/>
 <meta content="https://codetotal.io" property="og:url"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:description"/>
-</meta></meta></meta></meta><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
+</meta></meta></meta></meta></meta><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
             html.glightbox-open { overflow: initial; height: 100%; }
             .gslide-title { margin-top: 0px; user-select: text; }
             .gslide-desc { color: #666; user-select: text; }
@@ -320,6 +321,7 @@ <h2 id="unreleased-beta-main-branch-content">[Unreleased] (beta, main branch con
 </li>
 <li>Back-End<ul>
 <li>Bug fix: SBOM packages not showing up in report page. Async parsing of packages information in SBOM module</li>
+<li>Retry calls to pypi or npm in case first attempts are failing</li>
 </ul>
 </li>
 </ul>
@@ -332,9 +334,7 @@ <h2 id="v050-2023-08-10">[v0.5.0] - 2023-08-10</h2>
 </li>
 </ul>
 <ul>
-<li>
-<p>Front-end</p>
-<ul>
+<li>Front-end<ul>
 <li>Add linters logos</li>
 </ul>
 </li>
@@ -353,9 +353,7 @@ <h2 id="v040-2023-08-09">[v0.4.0] - 2023-08-09</h2>
 </ul>
 <h2 id="v030-2023-08-09">[v0.3.0] - 2023-08-09</h2>
 <ul>
-<li>
-<p>Global</p>
-<ul>
+<li>Global<ul>
 <li>Doc: display linter icons</li>
 </ul>
 </li>
@@ -437,7 +435,7 @@ <h2 id="v010-2023-08-07">[v0.1.0] - 2023-08-07</h2>
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/contributing/index.html b/contributing/index.html
index fd40a12..b0f6678 100644
--- a/contributing/index.html
+++ b/contributing/index.html
@@ -5,6 +5,7 @@
 <head>
 <meta charset="utf-8"/>
 <meta content="width=device-width,initial-scale=1" name="viewport"/>
+<meta content="CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="description"/>
 <meta content="Nicolas Vuillamy" name="author"/>
 <link href="https://codetotal.io/contributing/" rel="canonical"/>
 <link href="../security-linters/" rel="prev"/>
@@ -23,7 +24,7 @@
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" name="twitter:image:src">
 <meta content="@nvuillam" name="twitter:site">
 <meta content="summary_large_image" name="twitter:card">
-<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title"/>
+<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title">
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:description"/>
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" property="og:image"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:image:alt"/>
@@ -32,7 +33,7 @@
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:title"/>
 <meta content="https://codetotal.io" property="og:url"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:description"/>
-</meta></meta></meta></meta><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
+</meta></meta></meta></meta></meta><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
             html.glightbox-open { overflow: initial; height: 100%; }
             .gslide-title { margin-top: 0px; user-select: text; }
             .gslide-desc { color: #666; user-select: text; }
@@ -828,7 +829,7 @@ <h2 id="release-management">Release Management</h2>
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/index.html b/index.html
index 4c8b51e..85983e9 100644
--- a/index.html
+++ b/index.html
@@ -5,6 +5,7 @@
 <head>
 <meta charset="utf-8"/>
 <meta content="width=device-width,initial-scale=1" name="viewport"/>
+<meta content="CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="description"/>
 <meta content="Nicolas Vuillamy" name="author"/>
 <link href="https://codetotal.io/" rel="canonical"/>
 <link href="quick-start/" rel="next"/>
@@ -22,7 +23,7 @@
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" name="twitter:image:src">
 <meta content="@nvuillam" name="twitter:site">
 <meta content="summary_large_image" name="twitter:card">
-<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title"/>
+<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title">
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:description"/>
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" property="og:image"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:image:alt"/>
@@ -31,7 +32,7 @@
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:title"/>
 <meta content="https://codetotal.io" property="og:url"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:description"/>
-</meta></meta></meta></meta><link href="assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
+</meta></meta></meta></meta></meta><link href="assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
             html.glightbox-open { overflow: initial; height: 100%; }
             .gslide-title { margin-top: 0px; user-select: text; }
             .gslide-desc { color: #666; user-select: text; }
@@ -318,7 +319,7 @@ <h2 id="scan-files">Scan file(s)</h2>
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/license-explanations/index.html b/license-explanations/index.html
index 3bbde08..ac9e319 100644
--- a/license-explanations/index.html
+++ b/license-explanations/index.html
@@ -323,7 +323,7 @@ <h2 id="what-you-could-do">What you could do</h2>
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/license/index.html b/license/index.html
index de7892c..7ac7456 100644
--- a/license/index.html
+++ b/license/index.html
@@ -5,6 +5,7 @@
 <head>
 <meta charset="utf-8"/>
 <meta content="width=device-width,initial-scale=1" name="viewport"/>
+<meta content="CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="description"/>
 <meta content="Nicolas Vuillamy" name="author"/>
 <link href="https://codetotal.io/license/" rel="canonical"/>
 <link href="../contributing/" rel="prev"/>
@@ -23,7 +24,7 @@
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" name="twitter:image:src">
 <meta content="@nvuillam" name="twitter:site">
 <meta content="summary_large_image" name="twitter:card">
-<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title"/>
+<meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:title">
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." name="twitter:description"/>
 <meta content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" property="og:image"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:image:alt"/>
@@ -32,7 +33,7 @@
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:title"/>
 <meta content="https://codetotal.io" property="og:url"/>
 <meta content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." property="og:description"/>
-</meta></meta></meta></meta><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
+</meta></meta></meta></meta></meta><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
             html.glightbox-open { overflow: initial; height: 100%; }
             .gslide-title { margin-top: 0px; user-select: text; }
             .gslide-desc { color: #666; user-select: text; }
@@ -950,7 +951,7 @@ <h2 id="gnu-affero-general-public-license">GNU Affero General Public License</h2
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/quick-start/index.html b/quick-start/index.html
index 70b15c7..4042872 100644
--- a/quick-start/index.html
+++ b/quick-start/index.html
@@ -361,7 +361,7 @@ <h3 id="start-codetotal">Start CodeTotal</h3>
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/search/search_index.json b/search/search_index.json
index 2285ff1..951ace8 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"CodeTotal","text":"<p>CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses.</p> <p>Start now !</p> <p>Brought to you by OX Security, powered by MegaLinter</p>"},{"location":"#scan-repository","title":"Scan repository","text":"<p>Scan an entire repository</p> <p></p>"},{"location":"#scan-snippets","title":"Scan snippets","text":"<p>Copy-paste a snippet in any language.</p> <p></p>"},{"location":"#scan-files","title":"Scan file(s)","text":"<p>Select a file to scan, it can be:</p> <ul> <li>any source code file</li> <li>a zip containing a folder that will be extracted before scan.</li> </ul> <p></p>"},{"location":"CHANGELOG/","title":"Changelog","text":"<p>All notable changes to this project will be documented in this file.</p> <p>The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.</p>"},{"location":"CHANGELOG/#unreleased-beta-main-branch-content","title":"[Unreleased] (beta, main branch content)","text":"<p>Can be run using <code>npm run codetotal:beta</code></p> <ul> <li>Global</li> </ul> <ul> <li>Front-end<ul> <li>Add language label</li> <li>Add missing icon for Java</li> <li>Show language only if it's available</li> <li>Detect language for file analysis</li> <li>Change score to risk</li> <li>Remove auto focus from analysis tabs</li> <li>Add auto focus to snippet &amp; repo inputs</li> <li>Highlight resource type in report header</li> </ul> </li> <li>Back-End<ul> <li>Bug fix: SBOM packages not showing up in report page. Async parsing of packages information in SBOM module</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v050-2023-08-10","title":"[v0.5.0] - 2023-08-10","text":"<ul> <li>Global<ul> <li>Add animations to documentation - Refactor animations with black mode &amp; linter icons</li> <li>Add Google Tag Id for online doc</li> </ul> </li> </ul> <ul> <li> <p>Front-end</p> <ul> <li>Add linters logos</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v040-2023-08-09","title":"[v0.4.0] - 2023-08-09","text":"<ul> <li> <p>Global</p> <ul> <li>Use latest version for production mode (by default), or beta version of MegaLinter to run CodeTotal in development mode</li> <li>Documentation of docker-compose variables</li> <li>docker-compose new variable: <code>REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS=--only-verified</code></li> <li>Badges in README</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v030-2023-08-09","title":"[v0.3.0] - 2023-08-09","text":"<ul> <li> <p>Global</p> <ul> <li>Doc: display linter icons</li> </ul> </li> </ul> <ul> <li>Front-end<ul> <li>Fix error page styles and apply the fallback error page to all routes</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v020-2023-08-09","title":"[v0.2.0] - 2023-08-09","text":"<ul> <li> <p>Global</p> <ul> <li>Use <code>latest</code> codetotal-server docker image in production docker-compose.yml</li> <li>Deploy online doc when any markdown file is updated</li> <li>Factorize docker-compose<ul> <li><code>npm run codetotal</code> runs latest release of CodeTotal and beta version MegaLinter (in the future it will be latest)</li> <li><code>npm run codetotal:beta</code> runs beta version of CodeTotal and MegaLinter</li> <li><code>npm run codetotal:dev</code> locally builds CodeTotal then runs it with beta version of MegaLinter</li> </ul> </li> </ul> </li> </ul> <ul> <li> <p>Front-end</p> <ul> <li>Language selection in snippet analysis form</li> <li>Language name added next to the icon in report header</li> <li>\"CodeTotal\" text added to the footer</li> </ul> </li> </ul> <ul> <li>Back-End<ul> <li>Add SBOM management for NPM packages<ul> <li>SBOM info failure management</li> </ul> </li> <li>Replace nodemon by ts-node to run back-end in dev mode</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v010-2023-08-07","title":"[v0.1.0] - 2023-08-07","text":"<ul> <li>Initial public version<ul> <li>CodeTotal front-end</li> <li>CodeTotal back-end</li> <li>Ready to use docker-compose using CodeTotal and MegaLinter images</li> <li>Online Documentation on https://codetotal.io</li> <li>Contributing instructions</li> </ul> </li> </ul>"},{"location":"contributing/","title":"Contribute","text":"<ul> <li>Development Mode</li> <li>Available Scripts</li> <li>Config</li> <li>Building For Production</li> <li>Debugging in VSCode</li> <li>Messages from MegaLinter server<ul> <li>Start MegaLinter analysis</li> <li>Start Linter analysis</li> <li>Complete Linter analysis</li> <li>Complete MegaLinter analysis</li> <li>MegaLinter server error</li> </ul> </li> <li>Release Management</li> </ul>"},{"location":"contributing/#development-mode","title":"Development Mode","text":"<ul> <li>Clone this repo</li> <li>Run <code>npm i</code> to install dependencies</li> <li>Start megalinter server <code>npm run start:megalinter</code></li> <li>Run <code>npm start</code></li> <li>Open <code>codetotal app</code></li> </ul>"},{"location":"contributing/#available-scripts","title":"Available Scripts","text":"<ul> <li><code>npm start</code> start all projects in development mode</li> <li><code>npm run lint</code> lint all projects</li> <li><code>npm run build:be</code> build the backend (used by <code>launch.json</code> file for debugging)</li> <li><code>npm run start:fe</code> start the FE in development mode</li> <li><code>npm test</code> run all unit tests</li> </ul>"},{"location":"contributing/#config","title":"Config","text":"<p>Add a <code>.env</code> file in the root of the project. Only variables starting with the <code>CODETOTAL_</code> prefix will be injected into the frontend bundle.</p> <pre><code># MEGALINTER\nMEGALINTER_ANALYSIS_URL=http://127.0.0.1:8000/analysis\nMEGALINTER_UPLOAD_URL=http://127.0.0.1:8000/upload-file\nMEGALINTER_REDIS_URL=redis://127.0.0.1:6379\nMEGALINTER_REDIS_CHANNEL=megalinter:pubsub:&lt;request-id&gt;\n\n# BACKEND\nCODETOTAL_HTTP_PORT=8081\nCODETOTAL_HTTP_HOST=127.0.0.1\nCODETOTAL_WS_PORT=8080\nCODETOTAL_WS_HOST=127.0.0.1\nDEBUG_MODULES=actions,megalinter,stores,transport\n\n# FRONTEND\nCODETOTAL_UPLOAD_FILE_LIMIT_BYTES=10000000\n</code></pre>"},{"location":"contributing/#building-for-production","title":"Building For Production","text":"<ul> <li>Config files must be set before the build (see <code>Config</code> section)</li> <li>Run <code>npm run build</code> at the root folder</li> <li>This will create a <code>dist</code> folder with the backend code</li> <li>The frontend code will be under <code>dist/public</code></li> <li>Run using <code>npm run production</code> (equivalent to <code>node dist/index.js</code>)</li> </ul>"},{"location":"contributing/#debugging-in-vscode","title":"Debugging in VSCode","text":"<p>Add a <code>launch.json</code> file under the <code>.vscode</code> folder with the following content:</p> <pre><code>{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"type\": \"node\",\n      \"request\": \"launch\",\n      \"name\": \"Build Project\",\n      \"program\": \"${workspaceFolder}/packages/backend/dist/index.js\",\n      \"envFile\": \"${workspaceFolder}/.env\",\n      \"preLaunchTask\": \"npm: build:be\",\n      \"sourceMaps\": true,\n      \"smartStep\": true,\n      \"internalConsoleOptions\": \"openOnSessionStart\",\n      \"outFiles\": [\"${workspaceFolder}/packages/backend/dist/**/*.js\"]\n    }\n  ]\n}\n</code></pre>"},{"location":"contributing/#messages-from-megalinter-server","title":"Messages from MegaLinter server","text":"<p>Event-based management of MegaLinter Server can send the following list of messages into Redis PUBSUB channel built the following way: megalinter:pubsub:REQUEST_ID</p> <p>Example: <code>megalinter:pubsub:RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004</code></p>"},{"location":"contributing/#start-megalinter-analysis","title":"Start MegaLinter analysis","text":"<p>This message is sent once by analysis, when a MegaLinter instance has identified the linters to run and is about to start them.</p> <p>Example of megalinterStart messageType:</p> <pre><code>{\n  \"messageType\": \"megalinterStart\",\n  \"megaLinterStatus\": \"created\",\n  \"linters\": [\n    {\n      \"descriptorId\": \"BASH\",\n      \"linterId\": \"bash-exec\",\n      \"linterKey\": \"BASH_EXEC\",\n      \"linterVersion\": \"5.2.15\",\n      \"linterCliLintMode\": \"file\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_bash_exec\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/bash-exec.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false,\n      \"filesNumber\": 1\n    },\n    {\n      \"descriptorId\": \"BASH\",\n      \"linterId\": \"shellcheck\",\n      \"linterKey\": \"BASH_SHELLCHECK\",\n      \"linterVersion\": \"0.9.0\",\n      \"linterCliLintMode\": \"list_of_files\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_shellcheck\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/shellcheck.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false,\n      \"filesNumber\": 1\n    },\n    {\n      \"descriptorId\": \"BASH\",\n      \"linterId\": \"shfmt\",\n      \"linterKey\": \"BASH_SHFMT\",\n      \"linterVersion\": \"ERROR\",\n      \"linterCliLintMode\": \"list_of_files\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_shfmt\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/shfmt.png\",\n      \"isFormatter\": true,\n      \"isSBOM\": false,\n      \"filesNumber\": 1\n    },\n    {\n      \"descriptorId\": \"COPYPASTE\",\n      \"linterId\": \"jscpd\",\n      \"linterKey\": \"COPYPASTE_JSCPD\",\n      \"linterVersion\": \"ERROR\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/copypaste_jscpd\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"checkov\",\n      \"linterKey\": \"REPOSITORY_CHECKOV\",\n      \"linterVersion\": \"3.11\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_checkov\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/checkov.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"devskim\",\n      \"linterKey\": \"REPOSITORY_DEVSKIM\",\n      \"linterVersion\": \"1.0.11\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_devskim\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/devskim.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"dustilock\",\n      \"linterKey\": \"REPOSITORY_DUSTILOCK\",\n      \"linterVersion\": \"1.2.0\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_dustilock\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/dustilock.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"git_diff\",\n      \"linterKey\": \"REPOSITORY_GIT_DIFF\",\n      \"linterVersion\": \"2.38.5\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_git_diff\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"gitleaks\",\n      \"linterKey\": \"REPOSITORY_GITLEAKS\",\n      \"linterVersion\": \"8.17.0\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_gitleaks\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/gitleaks.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"kics\",\n      \"linterKey\": \"REPOSITORY_KICS\",\n      \"linterVersion\": \"1.7.3\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_kics\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/kics.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"secretlint\",\n      \"linterKey\": \"REPOSITORY_SECRETLINT\",\n      \"linterVersion\": \"7.0.3\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_secretlint\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/secretlint.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"semgrep\",\n      \"linterKey\": \"REPOSITORY_SEMGREP\",\n      \"linterVersion\": \"1.31.2\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_semgrep\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/semgrep.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"trivy\",\n      \"linterKey\": \"REPOSITORY_TRIVY\",\n      \"linterVersion\": \"0.43.1\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/trivy.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"SPELL\",\n      \"linterId\": \"cspell\",\n      \"linterKey\": \"SPELL_CSPELL\",\n      \"linterVersion\": \"ERROR\",\n      \"linterCliLintMode\": \"list_of_files\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/spell_cspell\",\n      \"isFormatter\": false,\n      \"filesNumber\": 1,\n      \"isSBOM\": false\n    }\n  ],\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\"\n}\n</code></pre>"},{"location":"contributing/#start-linter-analysis","title":"Start Linter analysis","text":"<p>This message is sent once by linter run, it indicates that a single linter has started running.</p> <p>Example of linterStart messageType with <code>linterCliLintMode=project</code>:</p> <pre><code>{\n  \"messageType\": \"linterStart\",\n  \"linterStatus\": \"started\",\n  \"descriptorId\": \"REPOSITORY\",\n  \"linterId\": \"trivy\",\n  \"linterKey\": \"REPOSITORY_TRIVY\",\n  \"linterVersion\": \"0.43.1\",\n  \"linterCliLintMode\": \"project\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n  \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n  \"isFormatter\": false,\n  \"isSBOM\": false\n}\n</code></pre> <p>Example of linterStart messageType with <code>linterCliLintMode=list_of_files</code> (with filesNumber additional property):</p> <pre><code>{\n  \"messageType\": \"linterStart\",\n  \"linterStatus\": \"started\",\n  \"descriptorId\": \"BASH\",\n  \"linterId\": \"shellcheck\",\n  \"linterKey\": \"BASH_SHELLCHECK\",\n  \"linterVersion\": \"0.9.0\",\n  \"linterCliLintMode\": \"list_of_files\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n  \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_shellcheck\",\n  \"isFormatter\": false,\n  \"isSBOM\": false,\n  \"filesNumber\": 1\n}\n</code></pre>"},{"location":"contributing/#complete-linter-analysis","title":"Complete Linter analysis","text":"<p>This message is sent once by linter run, it indicates that a single linter has been completed.</p> <p>If SARIF is available, it will be located in <code>outputSarif</code> property, otherwise results can be found in <code>outputText</code> and or <code>outputJson</code>.</p> <p>Example of linterComplete messageType:</p> <pre><code>{\n  \"messageType\": \"linterComplete\",\n  \"linterStatus\": \"success\",\n  \"linterErrorNumber\": 0,\n  \"linterStatusMessage\": \"No errors were found in the linting process\",\n  \"linterElapsedTime\": 11.16,\n  \"linterCliCommand\": [\n    \"trivy\",\n    \"fs\",\n    \"--scanners\",\n    \"vuln,config\",\n    \"--exit-code\",\n    \"1\",\n    \"--format\",\n    \"sarif\",\n    \"-o\",\n    \"/tmp/ct-megalinter-xmv82bvyv/megalinter-reports/sarif/REPOSITORY_TRIVY.sarif\",\n    \".\"\n  ],\n  \"descriptorId\": \"REPOSITORY\",\n  \"linterId\": \"trivy\",\n  \"linterKey\": \"REPOSITORY_TRIVY\",\n  \"linterVersion\": \"0.43.1\",\n  \"linterCliLintMode\": \"project\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n  \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n  \"isFormatter\": false,\n  \"isSBOM\": false,\n  \"outputSarif\": {\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"runs\": [\n      {\n        \"columnKind\": \"utf16CodeUnits\",\n        \"originalUriBaseIds\": {\n          \"ROOTPATH\": {\n            \"uri\": \"file:///\"\n          }\n        },\n        \"properties\": {\n          \"megalinter\": {\n            \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n            \"linterKey\": \"REPOSITORY_TRIVY\",\n            \"linterVersion\": \"0.43.1\"\n          }\n        },\n        \"results\": [],\n        \"tool\": {\n          \"driver\": {\n            \"fullName\": \"Trivy Vulnerability Scanner\",\n            \"informationUri\": \"https://github.com/aquasecurity/trivy\",\n            \"name\": \"Trivy (MegaLinter REPOSITORY_TRIVY)\",\n            \"rules\": [],\n            \"version\": \"0.43.1\"\n          }\n        }\n      }\n    ],\n    \"version\": \"2.1.0\"\n  }\n}\n</code></pre>"},{"location":"contributing/#complete-megalinter-analysis","title":"Complete MegaLinter analysis","text":"<p>This message is sent once by analysis, when a MegaLinter analysis is completed.</p> <p>CodeTotal stops listening to the requestId pubsub channel once this message is received, as no new message will be sent through this channel.</p> <p>Example of megalinterComplete messageType:</p> <pre><code>{\n  \"messageType\": \"megalinterComplete\",\n  \"megaLinterStatus\": \"completed\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\"\n}\n</code></pre>"},{"location":"contributing/#megalinter-server-error","title":"MegaLinter server error","text":"<p>In some cases, it is not possible for MegaLinter to start an analysis because there has been an error during initialization.</p> <p>In that case, CodeTotal stops listening to the pubsub channel, as no more messages will be sent.</p> <p>List of errors:</p> <ul> <li><code>missingAnalysisType</code>: Missing type (snippet, file or repository)</li> <li><code>gitCloneError</code>: Unable to clone the repository (probably not existing or not reachable)</li> <li><code>uploadedFileNotFound</code>: Unable to find file(s) that were supposed to be uploaded by a previous HTTP call to <code>/upload-file</code></li> <li><code>snippetGuessError</code>: Unable to automatically detect the language of a code snippet</li> <li><code>snippetBuildError</code>: Unable to find a file extension for the guessed snipper language</li> </ul> <p>Example of serverError messageType</p> <pre><code>{\n  \"messageType\": \"serverError\",\n  \"message\": \"Unable to clone repository\\nCmd('git') failed due to: exit code(128)\\n cmdline: git clone -v -- https://github.com/nvuillam/node-sarif-builder2 /tmp/ct-megalinter-x0afpmcmb\\n stderr: 'Cloning into '/tmp/ct-megalinter-x0afpmcmb'...\\nfatal: could not read Username for 'https://github.com': No such device or address\\n'\",\n  \"errorCode\": \"gitCloneError\",\n  \"errorDetails\": {\n    \"error\": \"Cmd('git') failed due to: exit code(128)\\n cmdline: git clone -v -- https://github.com/nvuillam/node-sarif-builder2 /tmp/ct-megalinter-x0afpmcmb\\n stderr: 'Cloning into '/tmp/ct-megalinter-x0afpmcmb'...\\nfatal: could not read Username for 'https://github.com': No such device or address\\n'\"\n  },\n  \"requestId\": \"RQ_e630c962-1e7c-11ee-9258-0242ac120004\"\n}\n</code></pre>"},{"location":"contributing/#release-management","title":"Release Management","text":"<ul> <li>Create a sub-branch <code>main</code> branch, name it release/vX.XX.XX (example: <code>release/v1.2.0</code>)</li> </ul> <ul> <li>Update CHANGELOG.md to add the section about the content of the new release. Leave empty the beta section, then commit.</li> </ul> <ul> <li>Run <code>npm version --no-git-tag-version --new-version vX.XX.XX</code> (example: <code>npm version --no-git-tag-version --new-version v1.2.0</code>)</li> </ul> <ul> <li>Commit updates on package.json and package-lock.json with message <code>release vX.XX.XX</code></li> </ul> <ul> <li>Make a Pull Request to <code>main</code>. IMPORTANT: The PR title must contain <code>release</code> in lowercase. Example: <code>New release v1.2.0</code>.</li> </ul> <ul> <li>Merge the PR if everything is ok (use Squash &amp; Merge option), else perform linter fixes until jobs are green, then merge.</li> </ul> <ul> <li> <p>Create a new GitHub Release -&gt; https://github.com/oxsecurity/codetotal/releases/new</p> <ul> <li>Input your new version tag string (ex: <code>v1.2.0</code>)</li> <li>Name the release <code>CodeTotal vX.XX.XX</code> (ex: <code>CodeTotal v1.2.0</code>)</li> <li>Click on Generate Release Notes button</li> <li>Arrange the result with content of CHANGELOG.md if necessary (like breaking change instructions)</li> <li>Create the GitHub release: An automated job will be triggered and will release the associated CodeTotal Docker Image</li> </ul> </li> </ul>"},{"location":"license-explanations/","title":"License explanation","text":""},{"location":"license-explanations/#why-agpl-v3-license","title":"Why AGPL V3 License ?","text":"<p>CodeTotal is an open-source and free tool graciously provided to the developer community.</p> <p>We don't earn money with CodeTotal, but it takes a lot of time to maintain it, so we want to avoid companies to make money with it by selling software or services without sharing their sources, like it happened in the past with ElasticSearch or MongoDB.</p>"},{"location":"license-explanations/#what-you-can-do","title":"What you can do","text":"<ul> <li>Use CodeTotal with public repositories</li> <li>Use CodeTotal with private repositories, even commercial ones</li> <li>Use CodeTotal to build commercial closed-source applications</li> <li>Use CodeTotal with on-premise Git services, like Github Enterprise or Gitlab Community Edition</li> </ul>"},{"location":"license-explanations/#what-you-can-not-do","title":"What you can not do","text":"<ul> <li>Sell CodeTotal</li> <li>Expose a closed-source online service that calls CodeTotal in the background</li> </ul>"},{"location":"license-explanations/#what-you-could-do","title":"What you could do","text":"<p>If you have a professional use of CodeTotal, you can be nice and support us by sponsoring us, and ask your clients to sponsor us too :)</p> <p>Any questions ? Contact us !</p>"},{"location":"license/","title":"License","text":""},{"location":"license/#gnu-affero-general-public-license","title":"GNU Affero General Public License","text":"<pre><code>                    GNU AFFERO GENERAL PUBLIC LICENSE\n                       Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. &lt;https://fsf.org/&gt;\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n                            Preamble\n\n  The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n  The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works.  By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n  When we speak of free software, we are referring to freedom, not\nprice.  Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n  Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n  A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate.  Many developers of free software are heartened and\nencouraged by the resulting cooperation.  However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n  The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community.  It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server.  Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n  An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals.  This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n  The precise terms and conditions for copying, distribution and\nmodification follow.\n\n                       TERMS AND CONDITIONS\n\n  0. Definitions.\n\n  \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n  \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n  \"The Program\" refers to any copyrightable work licensed under this\nLicense.  Each licensee is addressed as \"you\".  \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n  To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy.  The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n  A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n  To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy.  Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n  To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies.  Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n  An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License.  If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n  1. Source Code.\n\n  The \"source code\" for a work means the preferred form of the work\nfor making modifications to it.  \"Object code\" means any non-source\nform of a work.\n\n  A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n  The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form.  A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n  The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities.  However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work.  For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n  The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n  The Corresponding Source for a work in source code form is that\nsame work.\n\n  2. Basic Permissions.\n\n  All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met.  This License explicitly affirms your unlimited\npermission to run the unmodified Program.  The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work.  This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n  You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force.  You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright.  Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n  Conveying under any other circumstances is permitted solely under\nthe conditions stated below.  Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n  3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n  No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n  When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n  4. Conveying Verbatim Copies.\n\n  You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n  You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n  5. Conveying Modified Source Versions.\n\n  You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n    a) The work must carry prominent notices stating that you modified\n    it, and giving a relevant date.\n\n    b) The work must carry prominent notices stating that it is\n    released under this License and any conditions added under section\n    7.  This requirement modifies the requirement in section 4 to\n    \"keep intact all notices\".\n\n    c) You must license the entire work, as a whole, under this\n    License to anyone who comes into possession of a copy.  This\n    License will therefore apply, along with any applicable section 7\n    additional terms, to the whole of the work, and all its parts,\n    regardless of how they are packaged.  This License gives no\n    permission to license the work in any other way, but it does not\n    invalidate such permission if you have separately received it.\n\n    d) If the work has interactive user interfaces, each must display\n    Appropriate Legal Notices; however, if the Program has interactive\n    interfaces that do not display Appropriate Legal Notices, your\n    work need not make them do so.\n\n  A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit.  Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n  6. Conveying Non-Source Forms.\n\n  You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n    a) Convey the object code in, or embodied in, a physical product\n    (including a physical distribution medium), accompanied by the\n    Corresponding Source fixed on a durable physical medium\n    customarily used for software interchange.\n\n    b) Convey the object code in, or embodied in, a physical product\n    (including a physical distribution medium), accompanied by a\n    written offer, valid for at least three years and valid for as\n    long as you offer spare parts or customer support for that product\n    model, to give anyone who possesses the object code either (1) a\n    copy of the Corresponding Source for all the software in the\n    product that is covered by this License, on a durable physical\n    medium customarily used for software interchange, for a price no\n    more than your reasonable cost of physically performing this\n    conveying of source, or (2) access to copy the\n    Corresponding Source from a network server at no charge.\n\n    c) Convey individual copies of the object code with a copy of the\n    written offer to provide the Corresponding Source.  This\n    alternative is allowed only occasionally and noncommercially, and\n    only if you received the object code with such an offer, in accord\n    with subsection 6b.\n\n    d) Convey the object code by offering access from a designated\n    place (gratis or for a charge), and offer equivalent access to the\n    Corresponding Source in the same way through the same place at no\n    further charge.  You need not require recipients to copy the\n    Corresponding Source along with the object code.  If the place to\n    copy the object code is a network server, the Corresponding Source\n    may be on a different server (operated by you or a third party)\n    that supports equivalent copying facilities, provided you maintain\n    clear directions next to the object code saying where to find the\n    Corresponding Source.  Regardless of what server hosts the\n    Corresponding Source, you remain obligated to ensure that it is\n    available for as long as needed to satisfy these requirements.\n\n    e) Convey the object code using peer-to-peer transmission, provided\n    you inform other peers where the object code and Corresponding\n    Source of the work are being offered to the general public at no\n    charge under subsection 6d.\n\n  A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n  A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling.  In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage.  For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product.  A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n  \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source.  The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n  If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information.  But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n  The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed.  Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n  Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n  7. Additional Terms.\n\n  \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law.  If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n  When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit.  (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.)  You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n  Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n    a) Disclaiming warranty or limiting liability differently from the\n    terms of sections 15 and 16 of this License; or\n\n    b) Requiring preservation of specified reasonable legal notices or\n    author attributions in that material or in the Appropriate Legal\n    Notices displayed by works containing it; or\n\n    c) Prohibiting misrepresentation of the origin of that material, or\n    requiring that modified versions of such material be marked in\n    reasonable ways as different from the original version; or\n\n    d) Limiting the use for publicity purposes of names of licensors or\n    authors of the material; or\n\n    e) Declining to grant rights under trademark law for use of some\n    trade names, trademarks, or service marks; or\n\n    f) Requiring indemnification of licensors and authors of that\n    material by anyone who conveys the material (or modified versions of\n    it) with contractual assumptions of liability to the recipient, for\n    any liability that these contractual assumptions directly impose on\n    those licensors and authors.\n\n  All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10.  If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term.  If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n  If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n  Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n  8. Termination.\n\n  You may not propagate or modify a covered work except as expressly\nprovided under this License.  Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n  However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n  Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n  Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License.  If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n  9. Acceptance Not Required for Having Copies.\n\n  You are not required to accept this License in order to receive or\nrun a copy of the Program.  Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance.  However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work.  These actions infringe copyright if you do\nnot accept this License.  Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n  10. Automatic Licensing of Downstream Recipients.\n\n  Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License.  You are not responsible\nfor enforcing compliance by third parties with this License.\n\n  An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations.  If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n  You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License.  For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n  11. Patents.\n\n  A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based.  The\nwork thus licensed is called the contributor's \"contributor version\".\n\n  A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version.  For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n  Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n  In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement).  To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n  If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients.  \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n  If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n  A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License.  You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n  Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n  12. No Surrender of Others' Freedom.\n\n  If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License.  If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all.  For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n  13. Remote Network Interaction; Use with the GNU General Public License.\n\n  Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software.  This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n  Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work.  The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n  14. Revised Versions of this License.\n\n  The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time.  Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n  Each version is given a distinguishing version number.  If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation.  If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n  If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n  Later license versions may give you additional or different\npermissions.  However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n  15. Disclaimer of Warranty.\n\n  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n  16. Limitation of Liability.\n\n  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n  17. Interpretation of Sections 15 and 16.\n\n  If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n                     END OF TERMS AND CONDITIONS\n\n            How to Apply These Terms to Your New Programs\n\n  If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n  To do so, attach the following notices to the program.  It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n    &lt;one line to give the program's name and a brief idea of what it does.&gt;\n    Copyright (C) &lt;year&gt;  &lt;name of author&gt;\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU Affero General Public License as published\n    by the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU Affero General Public License for more details.\n\n    You should have received a copy of the GNU Affero General Public License\n    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.\n\nAlso add information on how to contact you by electronic and paper mail.\n\n  If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source.  For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code.  There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n  You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n&lt;https://www.gnu.org/licenses/&gt;.\n</code></pre>"},{"location":"quick-start/","title":"Quick Start","text":""},{"location":"quick-start/#pre-requisites","title":"Pre-requisites","text":"<p>CodeTotal is based on docker images, so all you need to have is:</p> <ul> <li>docker installed and started on your computer, so our docker-compose.yml file can be interpreted.</li> <li>nodejs, to call npm startup script</li> </ul>"},{"location":"quick-start/#single-command","title":"Single Command","text":"<p>Run <code>npx mega-linter-runner@latest --codetotal</code></p> <p></p>"},{"location":"quick-start/#alternative-using-repository","title":"Alternative using repository","text":""},{"location":"quick-start/#clone-the-repository","title":"Clone the repository","text":"<ul> <li>Run <code>git clone https://github.com/oxsecurity/codetotal.git</code></li> </ul>"},{"location":"quick-start/#start-codetotal","title":"Start CodeTotal","text":"<ul> <li>Run <code>npm install</code></li> </ul> <ul> <li>Run <code>npm run codetotal</code><ul> <li>Alternative: <code>npm run codetotal:beta</code> to run beta version</li> </ul> </li> </ul> <ul> <li>Open http://localhost:8081/ in your Web browser</li> </ul>"},{"location":"security-linters/","title":"MegaLinter Security flavor","text":""},{"location":"security-linters/#embedded-linters","title":"Embedded linters","text":"<p>CodeTotal is based on MegaLinter security flavor.</p>"},{"location":"security-linters/#languages","title":"Languages","text":"Language Linter Additional BASH bash-execBASH_EXEC BASH shellcheckBASH_SHELLCHECK PYTHON banditPYTHON_BANDIT"},{"location":"security-linters/#tooling","title":"Tooling","text":"Tooling format Linter Additional ANSIBLE ansible-lintANSIBLE_ANSIBLE_LINT CLOUDFORMATION cfn-lintCLOUDFORMATION_CFN_LINT DOCKERFILE hadolintDOCKERFILE_HADOLINT KUBERNETES kubeconformKUBERNETES_KUBECONFORM KUBERNETES helmKUBERNETES_HELM KUBERNETES kubescapeKUBERNETES_KUBESCAPE TERRAFORM tflintTERRAFORM_TFLINT TERRAFORM terrascanTERRAFORM_TERRASCAN TERRAFORM terragruntTERRAFORM_TERRAGRUNT"},{"location":"security-linters/#other","title":"Other","text":"Code quality checker Linter Additional REPOSITORY checkovREPOSITORY_CHECKOV REPOSITORY devskimREPOSITORY_DEVSKIM REPOSITORY dustilockREPOSITORY_DUSTILOCK REPOSITORY gitleaksREPOSITORY_GITLEAKS REPOSITORY grypeREPOSITORY_GRYPE REPOSITORY kicsREPOSITORY_KICS REPOSITORY secretlintREPOSITORY_SECRETLINT REPOSITORY semgrepREPOSITORY_SEMGREP REPOSITORY syftREPOSITORY_SYFT REPOSITORY trivyREPOSITORY_TRIVY REPOSITORY trivy-sbomREPOSITORY_TRIVY_SBOM REPOSITORY trufflehogREPOSITORY_TRUFFLEHOG"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"CodeTotal","text":"<p>CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses.</p> <p>Start now !</p> <p>Brought to you by OX Security, powered by MegaLinter</p>"},{"location":"#scan-repository","title":"Scan repository","text":"<p>Scan an entire repository</p> <p></p>"},{"location":"#scan-snippets","title":"Scan snippets","text":"<p>Copy-paste a snippet in any language.</p> <p></p>"},{"location":"#scan-files","title":"Scan file(s)","text":"<p>Select a file to scan, it can be:</p> <ul> <li>any source code file</li> <li>a zip containing a folder that will be extracted before scan.</li> </ul> <p></p>"},{"location":"CHANGELOG/","title":"Changelog","text":"<p>All notable changes to this project will be documented in this file.</p> <p>The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.</p>"},{"location":"CHANGELOG/#unreleased-beta-main-branch-content","title":"[Unreleased] (beta, main branch content)","text":"<p>Can be run using <code>npm run codetotal:beta</code></p> <ul> <li>Global</li> </ul> <ul> <li>Front-end<ul> <li>Add language label</li> <li>Add missing icon for Java</li> <li>Show language only if it's available</li> <li>Detect language for file analysis</li> <li>Change score to risk</li> <li>Remove auto focus from analysis tabs</li> <li>Add auto focus to snippet &amp; repo inputs</li> <li>Highlight resource type in report header</li> </ul> </li> <li>Back-End<ul> <li>Bug fix: SBOM packages not showing up in report page. Async parsing of packages information in SBOM module</li> <li>Retry calls to pypi or npm in case first attempts are failing</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v050-2023-08-10","title":"[v0.5.0] - 2023-08-10","text":"<ul> <li>Global<ul> <li>Add animations to documentation - Refactor animations with black mode &amp; linter icons</li> <li>Add Google Tag Id for online doc</li> </ul> </li> </ul> <ul> <li>Front-end<ul> <li>Add linters logos</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v040-2023-08-09","title":"[v0.4.0] - 2023-08-09","text":"<ul> <li> <p>Global</p> <ul> <li>Use latest version for production mode (by default), or beta version of MegaLinter to run CodeTotal in development mode</li> <li>Documentation of docker-compose variables</li> <li>docker-compose new variable: <code>REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS=--only-verified</code></li> <li>Badges in README</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v030-2023-08-09","title":"[v0.3.0] - 2023-08-09","text":"<ul> <li>Global<ul> <li>Doc: display linter icons</li> </ul> </li> </ul> <ul> <li>Front-end<ul> <li>Fix error page styles and apply the fallback error page to all routes</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v020-2023-08-09","title":"[v0.2.0] - 2023-08-09","text":"<ul> <li> <p>Global</p> <ul> <li>Use <code>latest</code> codetotal-server docker image in production docker-compose.yml</li> <li>Deploy online doc when any markdown file is updated</li> <li>Factorize docker-compose<ul> <li><code>npm run codetotal</code> runs latest release of CodeTotal and beta version MegaLinter (in the future it will be latest)</li> <li><code>npm run codetotal:beta</code> runs beta version of CodeTotal and MegaLinter</li> <li><code>npm run codetotal:dev</code> locally builds CodeTotal then runs it with beta version of MegaLinter</li> </ul> </li> </ul> </li> </ul> <ul> <li> <p>Front-end</p> <ul> <li>Language selection in snippet analysis form</li> <li>Language name added next to the icon in report header</li> <li>\"CodeTotal\" text added to the footer</li> </ul> </li> </ul> <ul> <li>Back-End<ul> <li>Add SBOM management for NPM packages<ul> <li>SBOM info failure management</li> </ul> </li> <li>Replace nodemon by ts-node to run back-end in dev mode</li> </ul> </li> </ul>"},{"location":"CHANGELOG/#v010-2023-08-07","title":"[v0.1.0] - 2023-08-07","text":"<ul> <li>Initial public version<ul> <li>CodeTotal front-end</li> <li>CodeTotal back-end</li> <li>Ready to use docker-compose using CodeTotal and MegaLinter images</li> <li>Online Documentation on https://codetotal.io</li> <li>Contributing instructions</li> </ul> </li> </ul>"},{"location":"contributing/","title":"Contribute","text":"<ul> <li>Development Mode</li> <li>Available Scripts</li> <li>Config</li> <li>Building For Production</li> <li>Debugging in VSCode</li> <li>Messages from MegaLinter server<ul> <li>Start MegaLinter analysis</li> <li>Start Linter analysis</li> <li>Complete Linter analysis</li> <li>Complete MegaLinter analysis</li> <li>MegaLinter server error</li> </ul> </li> <li>Release Management</li> </ul>"},{"location":"contributing/#development-mode","title":"Development Mode","text":"<ul> <li>Clone this repo</li> <li>Run <code>npm i</code> to install dependencies</li> <li>Start megalinter server <code>npm run start:megalinter</code></li> <li>Run <code>npm start</code></li> <li>Open <code>codetotal app</code></li> </ul>"},{"location":"contributing/#available-scripts","title":"Available Scripts","text":"<ul> <li><code>npm start</code> start all projects in development mode</li> <li><code>npm run lint</code> lint all projects</li> <li><code>npm run build:be</code> build the backend (used by <code>launch.json</code> file for debugging)</li> <li><code>npm run start:fe</code> start the FE in development mode</li> <li><code>npm test</code> run all unit tests</li> </ul>"},{"location":"contributing/#config","title":"Config","text":"<p>Add a <code>.env</code> file in the root of the project. Only variables starting with the <code>CODETOTAL_</code> prefix will be injected into the frontend bundle.</p> <pre><code># MEGALINTER\nMEGALINTER_ANALYSIS_URL=http://127.0.0.1:8000/analysis\nMEGALINTER_UPLOAD_URL=http://127.0.0.1:8000/upload-file\nMEGALINTER_REDIS_URL=redis://127.0.0.1:6379\nMEGALINTER_REDIS_CHANNEL=megalinter:pubsub:&lt;request-id&gt;\n\n# BACKEND\nCODETOTAL_HTTP_PORT=8081\nCODETOTAL_HTTP_HOST=127.0.0.1\nCODETOTAL_WS_PORT=8080\nCODETOTAL_WS_HOST=127.0.0.1\nDEBUG_MODULES=actions,megalinter,stores,transport\n\n# FRONTEND\nCODETOTAL_UPLOAD_FILE_LIMIT_BYTES=10000000\n</code></pre>"},{"location":"contributing/#building-for-production","title":"Building For Production","text":"<ul> <li>Config files must be set before the build (see <code>Config</code> section)</li> <li>Run <code>npm run build</code> at the root folder</li> <li>This will create a <code>dist</code> folder with the backend code</li> <li>The frontend code will be under <code>dist/public</code></li> <li>Run using <code>npm run production</code> (equivalent to <code>node dist/index.js</code>)</li> </ul>"},{"location":"contributing/#debugging-in-vscode","title":"Debugging in VSCode","text":"<p>Add a <code>launch.json</code> file under the <code>.vscode</code> folder with the following content:</p> <pre><code>{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"type\": \"node\",\n      \"request\": \"launch\",\n      \"name\": \"Build Project\",\n      \"program\": \"${workspaceFolder}/packages/backend/dist/index.js\",\n      \"envFile\": \"${workspaceFolder}/.env\",\n      \"preLaunchTask\": \"npm: build:be\",\n      \"sourceMaps\": true,\n      \"smartStep\": true,\n      \"internalConsoleOptions\": \"openOnSessionStart\",\n      \"outFiles\": [\"${workspaceFolder}/packages/backend/dist/**/*.js\"]\n    }\n  ]\n}\n</code></pre>"},{"location":"contributing/#messages-from-megalinter-server","title":"Messages from MegaLinter server","text":"<p>Event-based management of MegaLinter Server can send the following list of messages into Redis PUBSUB channel built the following way: megalinter:pubsub:REQUEST_ID</p> <p>Example: <code>megalinter:pubsub:RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004</code></p>"},{"location":"contributing/#start-megalinter-analysis","title":"Start MegaLinter analysis","text":"<p>This message is sent once by analysis, when a MegaLinter instance has identified the linters to run and is about to start them.</p> <p>Example of megalinterStart messageType:</p> <pre><code>{\n  \"messageType\": \"megalinterStart\",\n  \"megaLinterStatus\": \"created\",\n  \"linters\": [\n    {\n      \"descriptorId\": \"BASH\",\n      \"linterId\": \"bash-exec\",\n      \"linterKey\": \"BASH_EXEC\",\n      \"linterVersion\": \"5.2.15\",\n      \"linterCliLintMode\": \"file\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_bash_exec\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/bash-exec.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false,\n      \"filesNumber\": 1\n    },\n    {\n      \"descriptorId\": \"BASH\",\n      \"linterId\": \"shellcheck\",\n      \"linterKey\": \"BASH_SHELLCHECK\",\n      \"linterVersion\": \"0.9.0\",\n      \"linterCliLintMode\": \"list_of_files\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_shellcheck\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/shellcheck.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false,\n      \"filesNumber\": 1\n    },\n    {\n      \"descriptorId\": \"BASH\",\n      \"linterId\": \"shfmt\",\n      \"linterKey\": \"BASH_SHFMT\",\n      \"linterVersion\": \"ERROR\",\n      \"linterCliLintMode\": \"list_of_files\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_shfmt\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/shfmt.png\",\n      \"isFormatter\": true,\n      \"isSBOM\": false,\n      \"filesNumber\": 1\n    },\n    {\n      \"descriptorId\": \"COPYPASTE\",\n      \"linterId\": \"jscpd\",\n      \"linterKey\": \"COPYPASTE_JSCPD\",\n      \"linterVersion\": \"ERROR\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/copypaste_jscpd\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"checkov\",\n      \"linterKey\": \"REPOSITORY_CHECKOV\",\n      \"linterVersion\": \"3.11\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_checkov\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/checkov.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"devskim\",\n      \"linterKey\": \"REPOSITORY_DEVSKIM\",\n      \"linterVersion\": \"1.0.11\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_devskim\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/devskim.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"dustilock\",\n      \"linterKey\": \"REPOSITORY_DUSTILOCK\",\n      \"linterVersion\": \"1.2.0\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_dustilock\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/dustilock.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"git_diff\",\n      \"linterKey\": \"REPOSITORY_GIT_DIFF\",\n      \"linterVersion\": \"2.38.5\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_git_diff\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"gitleaks\",\n      \"linterKey\": \"REPOSITORY_GITLEAKS\",\n      \"linterVersion\": \"8.17.0\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_gitleaks\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/gitleaks.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"kics\",\n      \"linterKey\": \"REPOSITORY_KICS\",\n      \"linterVersion\": \"1.7.3\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_kics\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/kics.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"secretlint\",\n      \"linterKey\": \"REPOSITORY_SECRETLINT\",\n      \"linterVersion\": \"7.0.3\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_secretlint\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/secretlint.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"semgrep\",\n      \"linterKey\": \"REPOSITORY_SEMGREP\",\n      \"linterVersion\": \"1.31.2\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_semgrep\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/semgrep.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"REPOSITORY\",\n      \"linterId\": \"trivy\",\n      \"linterKey\": \"REPOSITORY_TRIVY\",\n      \"linterVersion\": \"0.43.1\",\n      \"linterCliLintMode\": \"project\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n      \"iconPngUrl\": \"https://raw.githubusercontent.com/oxsecurity/megalinter/main/docs/assets/icons/linters/trivy.png\",\n      \"isFormatter\": false,\n      \"isSBOM\": false\n    },\n    {\n      \"descriptorId\": \"SPELL\",\n      \"linterId\": \"cspell\",\n      \"linterKey\": \"SPELL_CSPELL\",\n      \"linterVersion\": \"ERROR\",\n      \"linterCliLintMode\": \"list_of_files\",\n      \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n      \"docUrl\": \"https://megalinter.io/alpha/descriptors/spell_cspell\",\n      \"isFormatter\": false,\n      \"filesNumber\": 1,\n      \"isSBOM\": false\n    }\n  ],\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\"\n}\n</code></pre>"},{"location":"contributing/#start-linter-analysis","title":"Start Linter analysis","text":"<p>This message is sent once by linter run, it indicates that a single linter has started running.</p> <p>Example of linterStart messageType with <code>linterCliLintMode=project</code>:</p> <pre><code>{\n  \"messageType\": \"linterStart\",\n  \"linterStatus\": \"started\",\n  \"descriptorId\": \"REPOSITORY\",\n  \"linterId\": \"trivy\",\n  \"linterKey\": \"REPOSITORY_TRIVY\",\n  \"linterVersion\": \"0.43.1\",\n  \"linterCliLintMode\": \"project\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n  \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n  \"isFormatter\": false,\n  \"isSBOM\": false\n}\n</code></pre> <p>Example of linterStart messageType with <code>linterCliLintMode=list_of_files</code> (with filesNumber additional property):</p> <pre><code>{\n  \"messageType\": \"linterStart\",\n  \"linterStatus\": \"started\",\n  \"descriptorId\": \"BASH\",\n  \"linterId\": \"shellcheck\",\n  \"linterKey\": \"BASH_SHELLCHECK\",\n  \"linterVersion\": \"0.9.0\",\n  \"linterCliLintMode\": \"list_of_files\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n  \"docUrl\": \"https://megalinter.io/alpha/descriptors/bash_shellcheck\",\n  \"isFormatter\": false,\n  \"isSBOM\": false,\n  \"filesNumber\": 1\n}\n</code></pre>"},{"location":"contributing/#complete-linter-analysis","title":"Complete Linter analysis","text":"<p>This message is sent once by linter run, it indicates that a single linter has been completed.</p> <p>If SARIF is available, it will be located in <code>outputSarif</code> property, otherwise results can be found in <code>outputText</code> and or <code>outputJson</code>.</p> <p>Example of linterComplete messageType:</p> <pre><code>{\n  \"messageType\": \"linterComplete\",\n  \"linterStatus\": \"success\",\n  \"linterErrorNumber\": 0,\n  \"linterStatusMessage\": \"No errors were found in the linting process\",\n  \"linterElapsedTime\": 11.16,\n  \"linterCliCommand\": [\n    \"trivy\",\n    \"fs\",\n    \"--scanners\",\n    \"vuln,config\",\n    \"--exit-code\",\n    \"1\",\n    \"--format\",\n    \"sarif\",\n    \"-o\",\n    \"/tmp/ct-megalinter-xmv82bvyv/megalinter-reports/sarif/REPOSITORY_TRIVY.sarif\",\n    \".\"\n  ],\n  \"descriptorId\": \"REPOSITORY\",\n  \"linterId\": \"trivy\",\n  \"linterKey\": \"REPOSITORY_TRIVY\",\n  \"linterVersion\": \"0.43.1\",\n  \"linterCliLintMode\": \"project\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\",\n  \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n  \"isFormatter\": false,\n  \"isSBOM\": false,\n  \"outputSarif\": {\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"runs\": [\n      {\n        \"columnKind\": \"utf16CodeUnits\",\n        \"originalUriBaseIds\": {\n          \"ROOTPATH\": {\n            \"uri\": \"file:///\"\n          }\n        },\n        \"properties\": {\n          \"megalinter\": {\n            \"docUrl\": \"https://megalinter.io/alpha/descriptors/repository_trivy\",\n            \"linterKey\": \"REPOSITORY_TRIVY\",\n            \"linterVersion\": \"0.43.1\"\n          }\n        },\n        \"results\": [],\n        \"tool\": {\n          \"driver\": {\n            \"fullName\": \"Trivy Vulnerability Scanner\",\n            \"informationUri\": \"https://github.com/aquasecurity/trivy\",\n            \"name\": \"Trivy (MegaLinter REPOSITORY_TRIVY)\",\n            \"rules\": [],\n            \"version\": \"0.43.1\"\n          }\n        }\n      }\n    ],\n    \"version\": \"2.1.0\"\n  }\n}\n</code></pre>"},{"location":"contributing/#complete-megalinter-analysis","title":"Complete MegaLinter analysis","text":"<p>This message is sent once by analysis, when a MegaLinter analysis is completed.</p> <p>CodeTotal stops listening to the requestId pubsub channel once this message is received, as no new message will be sent through this channel.</p> <p>Example of megalinterComplete messageType:</p> <pre><code>{\n  \"messageType\": \"megalinterComplete\",\n  \"megaLinterStatus\": \"completed\",\n  \"requestId\": \"RQ_cbdd1d82-1e7b-11ee-9258-0242ac120004\"\n}\n</code></pre>"},{"location":"contributing/#megalinter-server-error","title":"MegaLinter server error","text":"<p>In some cases, it is not possible for MegaLinter to start an analysis because there has been an error during initialization.</p> <p>In that case, CodeTotal stops listening to the pubsub channel, as no more messages will be sent.</p> <p>List of errors:</p> <ul> <li><code>missingAnalysisType</code>: Missing type (snippet, file or repository)</li> <li><code>gitCloneError</code>: Unable to clone the repository (probably not existing or not reachable)</li> <li><code>uploadedFileNotFound</code>: Unable to find file(s) that were supposed to be uploaded by a previous HTTP call to <code>/upload-file</code></li> <li><code>snippetGuessError</code>: Unable to automatically detect the language of a code snippet</li> <li><code>snippetBuildError</code>: Unable to find a file extension for the guessed snipper language</li> </ul> <p>Example of serverError messageType</p> <pre><code>{\n  \"messageType\": \"serverError\",\n  \"message\": \"Unable to clone repository\\nCmd('git') failed due to: exit code(128)\\n cmdline: git clone -v -- https://github.com/nvuillam/node-sarif-builder2 /tmp/ct-megalinter-x0afpmcmb\\n stderr: 'Cloning into '/tmp/ct-megalinter-x0afpmcmb'...\\nfatal: could not read Username for 'https://github.com': No such device or address\\n'\",\n  \"errorCode\": \"gitCloneError\",\n  \"errorDetails\": {\n    \"error\": \"Cmd('git') failed due to: exit code(128)\\n cmdline: git clone -v -- https://github.com/nvuillam/node-sarif-builder2 /tmp/ct-megalinter-x0afpmcmb\\n stderr: 'Cloning into '/tmp/ct-megalinter-x0afpmcmb'...\\nfatal: could not read Username for 'https://github.com': No such device or address\\n'\"\n  },\n  \"requestId\": \"RQ_e630c962-1e7c-11ee-9258-0242ac120004\"\n}\n</code></pre>"},{"location":"contributing/#release-management","title":"Release Management","text":"<ul> <li>Create a sub-branch <code>main</code> branch, name it release/vX.XX.XX (example: <code>release/v1.2.0</code>)</li> </ul> <ul> <li>Update CHANGELOG.md to add the section about the content of the new release. Leave empty the beta section, then commit.</li> </ul> <ul> <li>Run <code>npm version --no-git-tag-version --new-version vX.XX.XX</code> (example: <code>npm version --no-git-tag-version --new-version v1.2.0</code>)</li> </ul> <ul> <li>Commit updates on package.json and package-lock.json with message <code>release vX.XX.XX</code></li> </ul> <ul> <li>Make a Pull Request to <code>main</code>. IMPORTANT: The PR title must contain <code>release</code> in lowercase. Example: <code>New release v1.2.0</code>.</li> </ul> <ul> <li>Merge the PR if everything is ok (use Squash &amp; Merge option), else perform linter fixes until jobs are green, then merge.</li> </ul> <ul> <li> <p>Create a new GitHub Release -&gt; https://github.com/oxsecurity/codetotal/releases/new</p> <ul> <li>Input your new version tag string (ex: <code>v1.2.0</code>)</li> <li>Name the release <code>CodeTotal vX.XX.XX</code> (ex: <code>CodeTotal v1.2.0</code>)</li> <li>Click on Generate Release Notes button</li> <li>Arrange the result with content of CHANGELOG.md if necessary (like breaking change instructions)</li> <li>Create the GitHub release: An automated job will be triggered and will release the associated CodeTotal Docker Image</li> </ul> </li> </ul>"},{"location":"license-explanations/","title":"License explanation","text":""},{"location":"license-explanations/#why-agpl-v3-license","title":"Why AGPL V3 License ?","text":"<p>CodeTotal is an open-source and free tool graciously provided to the developer community.</p> <p>We don't earn money with CodeTotal, but it takes a lot of time to maintain it, so we want to avoid companies to make money with it by selling software or services without sharing their sources, like it happened in the past with ElasticSearch or MongoDB.</p>"},{"location":"license-explanations/#what-you-can-do","title":"What you can do","text":"<ul> <li>Use CodeTotal with public repositories</li> <li>Use CodeTotal with private repositories, even commercial ones</li> <li>Use CodeTotal to build commercial closed-source applications</li> <li>Use CodeTotal with on-premise Git services, like Github Enterprise or Gitlab Community Edition</li> </ul>"},{"location":"license-explanations/#what-you-can-not-do","title":"What you can not do","text":"<ul> <li>Sell CodeTotal</li> <li>Expose a closed-source online service that calls CodeTotal in the background</li> </ul>"},{"location":"license-explanations/#what-you-could-do","title":"What you could do","text":"<p>If you have a professional use of CodeTotal, you can be nice and support us by sponsoring us, and ask your clients to sponsor us too :)</p> <p>Any questions ? Contact us !</p>"},{"location":"license/","title":"License","text":""},{"location":"license/#gnu-affero-general-public-license","title":"GNU Affero General Public License","text":"<pre><code>                    GNU AFFERO GENERAL PUBLIC LICENSE\n                       Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. &lt;https://fsf.org/&gt;\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n                            Preamble\n\n  The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n  The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works.  By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n  When we speak of free software, we are referring to freedom, not\nprice.  Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n  Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n  A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate.  Many developers of free software are heartened and\nencouraged by the resulting cooperation.  However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n  The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community.  It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server.  Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n  An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals.  This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n  The precise terms and conditions for copying, distribution and\nmodification follow.\n\n                       TERMS AND CONDITIONS\n\n  0. Definitions.\n\n  \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n  \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n  \"The Program\" refers to any copyrightable work licensed under this\nLicense.  Each licensee is addressed as \"you\".  \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n  To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy.  The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n  A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n  To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy.  Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n  To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies.  Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n  An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License.  If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n  1. Source Code.\n\n  The \"source code\" for a work means the preferred form of the work\nfor making modifications to it.  \"Object code\" means any non-source\nform of a work.\n\n  A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n  The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form.  A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n  The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities.  However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work.  For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n  The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n  The Corresponding Source for a work in source code form is that\nsame work.\n\n  2. Basic Permissions.\n\n  All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met.  This License explicitly affirms your unlimited\npermission to run the unmodified Program.  The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work.  This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n  You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force.  You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright.  Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n  Conveying under any other circumstances is permitted solely under\nthe conditions stated below.  Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n  3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n  No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n  When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n  4. Conveying Verbatim Copies.\n\n  You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n  You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n  5. Conveying Modified Source Versions.\n\n  You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n    a) The work must carry prominent notices stating that you modified\n    it, and giving a relevant date.\n\n    b) The work must carry prominent notices stating that it is\n    released under this License and any conditions added under section\n    7.  This requirement modifies the requirement in section 4 to\n    \"keep intact all notices\".\n\n    c) You must license the entire work, as a whole, under this\n    License to anyone who comes into possession of a copy.  This\n    License will therefore apply, along with any applicable section 7\n    additional terms, to the whole of the work, and all its parts,\n    regardless of how they are packaged.  This License gives no\n    permission to license the work in any other way, but it does not\n    invalidate such permission if you have separately received it.\n\n    d) If the work has interactive user interfaces, each must display\n    Appropriate Legal Notices; however, if the Program has interactive\n    interfaces that do not display Appropriate Legal Notices, your\n    work need not make them do so.\n\n  A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit.  Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n  6. Conveying Non-Source Forms.\n\n  You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n    a) Convey the object code in, or embodied in, a physical product\n    (including a physical distribution medium), accompanied by the\n    Corresponding Source fixed on a durable physical medium\n    customarily used for software interchange.\n\n    b) Convey the object code in, or embodied in, a physical product\n    (including a physical distribution medium), accompanied by a\n    written offer, valid for at least three years and valid for as\n    long as you offer spare parts or customer support for that product\n    model, to give anyone who possesses the object code either (1) a\n    copy of the Corresponding Source for all the software in the\n    product that is covered by this License, on a durable physical\n    medium customarily used for software interchange, for a price no\n    more than your reasonable cost of physically performing this\n    conveying of source, or (2) access to copy the\n    Corresponding Source from a network server at no charge.\n\n    c) Convey individual copies of the object code with a copy of the\n    written offer to provide the Corresponding Source.  This\n    alternative is allowed only occasionally and noncommercially, and\n    only if you received the object code with such an offer, in accord\n    with subsection 6b.\n\n    d) Convey the object code by offering access from a designated\n    place (gratis or for a charge), and offer equivalent access to the\n    Corresponding Source in the same way through the same place at no\n    further charge.  You need not require recipients to copy the\n    Corresponding Source along with the object code.  If the place to\n    copy the object code is a network server, the Corresponding Source\n    may be on a different server (operated by you or a third party)\n    that supports equivalent copying facilities, provided you maintain\n    clear directions next to the object code saying where to find the\n    Corresponding Source.  Regardless of what server hosts the\n    Corresponding Source, you remain obligated to ensure that it is\n    available for as long as needed to satisfy these requirements.\n\n    e) Convey the object code using peer-to-peer transmission, provided\n    you inform other peers where the object code and Corresponding\n    Source of the work are being offered to the general public at no\n    charge under subsection 6d.\n\n  A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n  A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling.  In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage.  For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product.  A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n  \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source.  The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n  If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information.  But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n  The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed.  Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n  Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n  7. Additional Terms.\n\n  \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law.  If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n  When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit.  (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.)  You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n  Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n    a) Disclaiming warranty or limiting liability differently from the\n    terms of sections 15 and 16 of this License; or\n\n    b) Requiring preservation of specified reasonable legal notices or\n    author attributions in that material or in the Appropriate Legal\n    Notices displayed by works containing it; or\n\n    c) Prohibiting misrepresentation of the origin of that material, or\n    requiring that modified versions of such material be marked in\n    reasonable ways as different from the original version; or\n\n    d) Limiting the use for publicity purposes of names of licensors or\n    authors of the material; or\n\n    e) Declining to grant rights under trademark law for use of some\n    trade names, trademarks, or service marks; or\n\n    f) Requiring indemnification of licensors and authors of that\n    material by anyone who conveys the material (or modified versions of\n    it) with contractual assumptions of liability to the recipient, for\n    any liability that these contractual assumptions directly impose on\n    those licensors and authors.\n\n  All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10.  If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term.  If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n  If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n  Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n  8. Termination.\n\n  You may not propagate or modify a covered work except as expressly\nprovided under this License.  Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n  However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n  Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n  Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License.  If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n  9. Acceptance Not Required for Having Copies.\n\n  You are not required to accept this License in order to receive or\nrun a copy of the Program.  Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance.  However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work.  These actions infringe copyright if you do\nnot accept this License.  Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n  10. Automatic Licensing of Downstream Recipients.\n\n  Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License.  You are not responsible\nfor enforcing compliance by third parties with this License.\n\n  An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations.  If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n  You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License.  For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n  11. Patents.\n\n  A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based.  The\nwork thus licensed is called the contributor's \"contributor version\".\n\n  A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version.  For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n  Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n  In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement).  To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n  If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients.  \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n  If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n  A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License.  You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n  Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n  12. No Surrender of Others' Freedom.\n\n  If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License.  If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all.  For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n  13. Remote Network Interaction; Use with the GNU General Public License.\n\n  Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software.  This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n  Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work.  The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n  14. Revised Versions of this License.\n\n  The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time.  Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n  Each version is given a distinguishing version number.  If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation.  If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n  If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n  Later license versions may give you additional or different\npermissions.  However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n  15. Disclaimer of Warranty.\n\n  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n  16. Limitation of Liability.\n\n  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n  17. Interpretation of Sections 15 and 16.\n\n  If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n                     END OF TERMS AND CONDITIONS\n\n            How to Apply These Terms to Your New Programs\n\n  If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n  To do so, attach the following notices to the program.  It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n    &lt;one line to give the program's name and a brief idea of what it does.&gt;\n    Copyright (C) &lt;year&gt;  &lt;name of author&gt;\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU Affero General Public License as published\n    by the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU Affero General Public License for more details.\n\n    You should have received a copy of the GNU Affero General Public License\n    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.\n\nAlso add information on how to contact you by electronic and paper mail.\n\n  If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source.  For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code.  There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n  You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n&lt;https://www.gnu.org/licenses/&gt;.\n</code></pre>"},{"location":"quick-start/","title":"Quick Start","text":""},{"location":"quick-start/#pre-requisites","title":"Pre-requisites","text":"<p>CodeTotal is based on docker images, so all you need to have is:</p> <ul> <li>docker installed and started on your computer, so our docker-compose.yml file can be interpreted.</li> <li>nodejs, to call npm startup script</li> </ul>"},{"location":"quick-start/#single-command","title":"Single Command","text":"<p>Run <code>npx mega-linter-runner@latest --codetotal</code></p> <p></p>"},{"location":"quick-start/#alternative-using-repository","title":"Alternative using repository","text":""},{"location":"quick-start/#clone-the-repository","title":"Clone the repository","text":"<ul> <li>Run <code>git clone https://github.com/oxsecurity/codetotal.git</code></li> </ul>"},{"location":"quick-start/#start-codetotal","title":"Start CodeTotal","text":"<ul> <li>Run <code>npm install</code></li> </ul> <ul> <li>Run <code>npm run codetotal</code><ul> <li>Alternative: <code>npm run codetotal:beta</code> to run beta version</li> </ul> </li> </ul> <ul> <li>Open http://localhost:8081/ in your Web browser</li> </ul>"},{"location":"security-linters/","title":"MegaLinter Security flavor","text":""},{"location":"security-linters/#embedded-linters","title":"Embedded linters","text":"<p>CodeTotal is based on MegaLinter security flavor.</p>"},{"location":"security-linters/#languages","title":"Languages","text":"Language Linter Additional BASH bash-execBASH_EXEC BASH shellcheckBASH_SHELLCHECK PYTHON banditPYTHON_BANDIT"},{"location":"security-linters/#tooling","title":"Tooling","text":"Tooling format Linter Additional ANSIBLE ansible-lintANSIBLE_ANSIBLE_LINT CLOUDFORMATION cfn-lintCLOUDFORMATION_CFN_LINT DOCKERFILE hadolintDOCKERFILE_HADOLINT KUBERNETES kubeconformKUBERNETES_KUBECONFORM KUBERNETES helmKUBERNETES_HELM KUBERNETES kubescapeKUBERNETES_KUBESCAPE TERRAFORM tflintTERRAFORM_TFLINT TERRAFORM terrascanTERRAFORM_TERRASCAN TERRAFORM terragruntTERRAFORM_TERRAGRUNT"},{"location":"security-linters/#other","title":"Other","text":"Code quality checker Linter Additional REPOSITORY checkovREPOSITORY_CHECKOV REPOSITORY devskimREPOSITORY_DEVSKIM REPOSITORY dustilockREPOSITORY_DUSTILOCK REPOSITORY gitleaksREPOSITORY_GITLEAKS REPOSITORY grypeREPOSITORY_GRYPE REPOSITORY kicsREPOSITORY_KICS REPOSITORY secretlintREPOSITORY_SECRETLINT REPOSITORY semgrepREPOSITORY_SEMGREP REPOSITORY syftREPOSITORY_SYFT REPOSITORY trivyREPOSITORY_TRIVY REPOSITORY trivy-sbomREPOSITORY_TRIVY_SBOM REPOSITORY trufflehogREPOSITORY_TRUFFLEHOG"}]}
\ No newline at end of file
diff --git a/security-linters/index.html b/security-linters/index.html
index fc42d1d..71e2265 100644
--- a/security-linters/index.html
+++ b/security-linters/index.html
@@ -508,7 +508,7 @@ <h3 id="other">Other</h3>
 <div class="md-footer-meta__inner md-grid">
 <div class="md-copyright">
 <div class="md-copyright__highlight">
-      Copyright © 2022 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
+      Copyright © 2023 <a href="https://www.ox.security/?ref=codetotal" target="_blank">OX Security</a>
 </div>
 </div>
 <div class="md-social">
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 338bb4b..76cfe8b 100644
Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ
