Snigdha-OS/documentation
2
0
Fork 0
mirror of https://github.com/Snigdha-OS/documentation.git synced 2025-09-06 19:15:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: update introduction.

Browse Source
This commit is contained in:
Eshan Roy
2024-03-24 12:13:32 +05:30
parent 83d52b0fa7
commit a40f80c436
18 changed files with 306 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-developers-guide-1-0a0.json Normal file
View File

@@ -0,0 +1,16 @@
{
"title": "Developers Guide",
"description": "Troubleshoot",
"slug": "/category/developers-guide-1",
"permalink": "/documentation/category/developers-guide-1",
"navigation": {
"previous": {
"title": "Deploy Package",
"permalink": "/documentation/dev_guide/deploy_packages"
},
"next": {
"title": "snigdhaos_blackbox",
"permalink": "/documentation/packages/snigdhaos_blackbox"
}
}
}

4
.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-developers-guide-ae5.json
View File

@@ -5,8 +5,8 @@
"permalink": "/documentation/category/developers-guide",
"navigation": {
"previous": {
"title": "Troubleshoot: Display",
"permalink": "/documentation/troubleshoot/display"
"title": "Blackbox",
"permalink": "/documentation/packages/snigdhaos_blackbox"
},
"next": {
"title": "Write Documentation",

16
.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-packages-eea.json Normal file
View File

@@ -0,0 +1,16 @@
{
"title": "Packages",
"description": "Troubleshoot",
"slug": "/category/packages",
"permalink": "/documentation/category/packages",
"navigation": {
"previous": {
"title": "Troubleshoot: Display",
"permalink": "/documentation/troubleshoot/display"
},
"next": {
"title": "Welcome",
"permalink": "/documentation/packages/snigdhaos_welcome"
}
}
}

2
.docusaurus/docusaurus-plugin-content-docs/default/site-docs-introduction-introduction-md-c62.json
View File

@@ -1,7 +1,7 @@
{
"id": "introduction/introduction",
"title": "Introduction",
"description": "Let's discover Docusaurus in less than 5 minutes.",
"description": "Snigdha OS is a light-weight, Powerful & Optimized Operating System built for Normal Users & Penetration Testers.",
"source": "@site/docs/introduction/introduction.md",
"sourceDirName": "introduction",
"slug": "/",

27
.docusaurus/docusaurus-plugin-content-docs/default/site-docs-packages-snigdhaos-blackbox-md-bbd.json Normal file
View File

@@ -0,0 +1,27 @@
{
"id": "packages/snigdhaos_blackbox",
"title": "Blackbox",
"description": "",
"source": "@site/docs/packages/snigdhaos_blackbox.md",
"sourceDirName": "packages",
"slug": "/packages/snigdhaos_blackbox",
"permalink": "/documentation/packages/snigdhaos_blackbox",
"draft": false,
"unlisted": false,
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/packages/snigdhaos_blackbox.md",
"tags": [],
"version": "current",
"sidebarPosition": 2,
"frontMatter": {
"sidebar_position": 2
},
"sidebar": "tutorialSidebar",
"previous": {
"title": "Welcome",
"permalink": "/documentation/packages/snigdhaos_welcome"
},
"next": {
"title": "Developers Guide",
"permalink": "/documentation/category/developers-guide"
}
}

27
.docusaurus/docusaurus-plugin-content-docs/default/site-docs-packages-snigdhaos-welcome-md-400.json Normal file
View File

@@ -0,0 +1,27 @@
{
"id": "packages/snigdhaos_welcome",
"title": "Welcome",
"description": "",
"source": "@site/docs/packages/snigdhaos_welcome.md",
"sourceDirName": "packages",
"slug": "/packages/snigdhaos_welcome",
"permalink": "/documentation/packages/snigdhaos_welcome",
"draft": false,
"unlisted": false,
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/packages/snigdhaos_welcome.md",
"tags": [],
"version": "current",
"sidebarPosition": 1,
"frontMatter": {
"sidebar_position": 1
},
"sidebar": "tutorialSidebar",
"previous": {
"title": "Packages",
"permalink": "/documentation/category/packages"
},
"next": {
"title": "Blackbox",
"permalink": "/documentation/packages/snigdhaos_blackbox"
}
}

4
.docusaurus/docusaurus-plugin-content-docs/default/site-docs-troubleshoot-display-md-e2e.json
View File

@@ -21,7 +21,7 @@
"permalink": "/documentation/troubleshoot/sound"
},
"next": {
"title": "Developers Guide",
"permalink": "/documentation/category/developers-guide"
"title": "Packages",
"permalink": "/documentation/category/packages"
}
}

37
.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json
View File

@@ -245,6 +245,29 @@
],
"href": "/documentation/category/troubleshoot"
},
{
"type": "category",
"label": "Packages",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Welcome",
"href": "/documentation/packages/snigdhaos_welcome",
"docId": "packages/snigdhaos_welcome",
"unlisted": false
},
{
"type": "link",
"label": "Blackbox",
"href": "/documentation/packages/snigdhaos_blackbox",
"docId": "packages/snigdhaos_blackbox",
"unlisted": false
}
],
"href": "/documentation/category/packages"
},
{
"type": "category",
"label": "Developers Guide",
@@ -416,7 +439,7 @@
"introduction/introduction": {
"id": "introduction/introduction",
"title": "Introduction",
"description": "Let's discover Docusaurus in less than 5 minutes.",
"description": "Snigdha OS is a light-weight, Powerful & Optimized Operating System built for Normal Users & Penetration Testers.",
"sidebar": "tutorialSidebar"
},
"introduction/release_notes": {
@@ -431,6 +454,18 @@
"description": "",
"sidebar": "tutorialSidebar"
},
"packages/snigdhaos_blackbox": {
"id": "packages/snigdhaos_blackbox",
"title": "Blackbox",
"description": "",
"sidebar": "tutorialSidebar"
},
"packages/snigdhaos_welcome": {
"id": "packages/snigdhaos_welcome",
"title": "Welcome",
"description": "",
"sidebar": "tutorialSidebar"
},
"post_installation/customization": {
"id": "post_installation/customization",
"title": "Customize Snigdha OS",

82
.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json
View File

@@ -531,7 +531,7 @@
{
"id": "introduction/introduction",
"title": "Introduction",
"description": "Let's discover Docusaurus in less than 5 minutes.",
"description": "Snigdha OS is a light-weight, Powerful & Optimized Operating System built for Normal Users & Penetration Testers.",
"source": "@site/docs/introduction/introduction.md",
"sourceDirName": "introduction",
"slug": "/",
@@ -610,6 +610,60 @@
"permalink": "/documentation/introduction/faqs"
}
},
{
"id": "packages/snigdhaos_blackbox",
"title": "Blackbox",
"description": "",
"source": "@site/docs/packages/snigdhaos_blackbox.md",
"sourceDirName": "packages",
"slug": "/packages/snigdhaos_blackbox",
"permalink": "/documentation/packages/snigdhaos_blackbox",
"draft": false,
"unlisted": false,
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/packages/snigdhaos_blackbox.md",
"tags": [],
"version": "current",
"sidebarPosition": 2,
"frontMatter": {
"sidebar_position": 2
},
"sidebar": "tutorialSidebar",
"previous": {
"title": "Welcome",
"permalink": "/documentation/packages/snigdhaos_welcome"
},
"next": {
"title": "Developers Guide",
"permalink": "/documentation/category/developers-guide"
}
},
{
"id": "packages/snigdhaos_welcome",
"title": "Welcome",
"description": "",
"source": "@site/docs/packages/snigdhaos_welcome.md",
"sourceDirName": "packages",
"slug": "/packages/snigdhaos_welcome",
"permalink": "/documentation/packages/snigdhaos_welcome",
"draft": false,
"unlisted": false,
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/packages/snigdhaos_welcome.md",
"tags": [],
"version": "current",
"sidebarPosition": 1,
"frontMatter": {
"sidebar_position": 1
},
"sidebar": "tutorialSidebar",
"previous": {
"title": "Packages",
"permalink": "/documentation/category/packages"
},
"next": {
"title": "Blackbox",
"permalink": "/documentation/packages/snigdhaos_blackbox"
}
},
{
"id": "post_installation/customization",
"title": "Customize Snigdha OS",
@@ -768,8 +822,8 @@
"permalink": "/documentation/troubleshoot/sound"
},
"next": {
"title": "Developers Guide",
"permalink": "/documentation/category/developers-guide"
"title": "Packages",
"permalink": "/documentation/category/packages"
}
},
{
@@ -1072,6 +1126,28 @@
"permalink": "/documentation/category/troubleshoot"
}
},
{
"type": "category",
"label": "Packages",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "doc",
"id": "packages/snigdhaos_welcome"
},
{
"type": "doc",
"id": "packages/snigdhaos_blackbox"
}
],
"link": {
"type": "generated-index",
"description": "Troubleshoot",
"slug": "/category/packages",
"permalink": "/documentation/category/packages"
}
},
{
"type": "category",
"label": "Developers Guide",

15
.docusaurus/globalData.json
View File

@@ -120,6 +120,16 @@
"path": "/documentation/introduction/reporting_bugs",
"sidebar": "tutorialSidebar"
},
{
"id": "packages/snigdhaos_blackbox",
"path": "/documentation/packages/snigdhaos_blackbox",
"sidebar": "tutorialSidebar"
},
{
"id": "packages/snigdhaos_welcome",
"path": "/documentation/packages/snigdhaos_welcome",
"sidebar": "tutorialSidebar"
},
{
"id": "post_installation/customization",
"path": "/documentation/post_installation/customization",
@@ -200,6 +210,11 @@
"path": "/documentation/category/troubleshoot",
"sidebar": "tutorialSidebar"
},
{
"id": "/category/packages",
"path": "/documentation/category/packages",
"sidebar": "tutorialSidebar"
},
{
"id": "/category/developers-guide",
"path": "/documentation/category/developers-guide",

3
.docusaurus/registry.js
View File

@@ -22,6 +22,7 @@ export default {
"categoryGeneratedIndex---documentation-category-developers-guide-06-e-997": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-developers-guide-06-e-997" */ "~docs/default/category-documentation-tutorialsidebar-category-developers-guide-ae5.json"), "~docs/default/category-documentation-tutorialsidebar-category-developers-guide-ae5.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-developers-guide-ae5.json")],
"categoryGeneratedIndex---documentation-category-installationb-20-365": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-installationb-20-365" */ "~docs/default/category-documentation-tutorialsidebar-category-installation-da6.json"), "~docs/default/category-documentation-tutorialsidebar-category-installation-da6.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-installation-da6.json")],
"categoryGeneratedIndex---documentation-category-introductionccd-ede": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-introductionccd-ede" */ "~docs/default/category-documentation-tutorialsidebar-category-introduction-344.json"), "~docs/default/category-documentation-tutorialsidebar-category-introduction-344.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-introduction-344.json")],
"categoryGeneratedIndex---documentation-category-packages-909-692": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-packages-909-692" */ "~docs/default/category-documentation-tutorialsidebar-category-packages-eea.json"), "~docs/default/category-documentation-tutorialsidebar-category-packages-eea.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-packages-eea.json")],
"categoryGeneratedIndex---documentation-category-post-installatione-54-a22": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-post-installatione-54-a22" */ "~docs/default/category-documentation-tutorialsidebar-category-post-installation-06e.json"), "~docs/default/category-documentation-tutorialsidebar-category-post-installation-06e.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-post-installation-06e.json")],
"categoryGeneratedIndex---documentation-category-troubleshootde-6-666": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-troubleshootde-6-666" */ "~docs/default/category-documentation-tutorialsidebar-category-troubleshoot-a4b.json"), "~docs/default/category-documentation-tutorialsidebar-category-troubleshoot-a4b.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-troubleshoot-a4b.json")],
"categoryGeneratedIndex---documentation-category-user-guide-698-266": [() => import(/* webpackChunkName: "categoryGeneratedIndex---documentation-category-user-guide-698-266" */ "~docs/default/category-documentation-tutorialsidebar-category-user-guide-b31.json"), "~docs/default/category-documentation-tutorialsidebar-category-user-guide-b31.json", require.resolveWeak("~docs/default/category-documentation-tutorialsidebar-category-user-guide-b31.json")],
@@ -56,6 +57,8 @@ export default {
"content---documentation-introduction-release-notes-1-b-1-d2e": [() => import(/* webpackChunkName: "content---documentation-introduction-release-notes-1-b-1-d2e" */ "@site/docs/introduction/release_notes.md"), "@site/docs/introduction/release_notes.md", require.resolveWeak("@site/docs/introduction/release_notes.md")],
"content---documentation-introduction-reporting-bugsdc-8-ae1": [() => import(/* webpackChunkName: "content---documentation-introduction-reporting-bugsdc-8-ae1" */ "@site/docs/introduction/reporting_bugs.md"), "@site/docs/introduction/reporting_bugs.md", require.resolveWeak("@site/docs/introduction/reporting_bugs.md")],
"content---documentation-markdown-page-393-bce": [() => import(/* webpackChunkName: "content---documentation-markdown-page-393-bce" */ "@site/src/pages/markdown-page.md"), "@site/src/pages/markdown-page.md", require.resolveWeak("@site/src/pages/markdown-page.md")],
"content---documentation-packages-snigdhaos-blackboxbbd-050": [() => import(/* webpackChunkName: "content---documentation-packages-snigdhaos-blackboxbbd-050" */ "@site/docs/packages/snigdhaos_blackbox.md"), "@site/docs/packages/snigdhaos_blackbox.md", require.resolveWeak("@site/docs/packages/snigdhaos_blackbox.md")],
"content---documentation-packages-snigdhaos-welcome-400-dfa": [() => import(/* webpackChunkName: "content---documentation-packages-snigdhaos-welcome-400-dfa" */ "@site/docs/packages/snigdhaos_welcome.md"), "@site/docs/packages/snigdhaos_welcome.md", require.resolveWeak("@site/docs/packages/snigdhaos_welcome.md")],
"content---documentation-post-installation-customization-9-cb-3c6": [() => import(/* webpackChunkName: "content---documentation-post-installation-customization-9-cb-3c6" */ "@site/docs/post_installation/customization.md"), "@site/docs/post_installation/customization.md", require.resolveWeak("@site/docs/post_installation/customization.md")],
"content---documentation-post-installation-install-packages-904-e99": [() => import(/* webpackChunkName: "content---documentation-post-installation-install-packages-904-e99" */ "@site/docs/post_installation/install_packages.md"), "@site/docs/post_installation/install_packages.md", require.resolveWeak("@site/docs/post_installation/install_packages.md")],
"content---documentation-post-installation-languagead-7-478": [() => import(/* webpackChunkName: "content---documentation-post-installation-languagead-7-478" */ "@site/docs/post_installation/language.md"), "@site/docs/post_installation/language.md", require.resolveWeak("@site/docs/post_installation/language.md")],

24
.docusaurus/routes.js
View File

@@ -99,15 +99,15 @@ export default [
},
{
path: '/documentation/',
component: ComponentCreator('/documentation/', 'd82'),
component: ComponentCreator('/documentation/', 'df7'),
routes: [
{
path: '/documentation/',
component: ComponentCreator('/documentation/', '3e8'),
component: ComponentCreator('/documentation/', 'a50'),
routes: [
{
path: '/documentation/',
component: ComponentCreator('/documentation/', 'c4e'),
component: ComponentCreator('/documentation/', 'dbd'),
routes: [
{
path: '/documentation/before_installation/imporatnt_notes',
@@ -151,6 +151,12 @@ export default [
exact: true,
sidebar: "tutorialSidebar"
},
{
path: '/documentation/category/packages',
component: ComponentCreator('/documentation/category/packages', '0e6'),
exact: true,
sidebar: "tutorialSidebar"
},
{
path: '/documentation/category/post-installation',
component: ComponentCreator('/documentation/category/post-installation', 'ee0'),
@@ -277,6 +283,18 @@ export default [
exact: true,
sidebar: "tutorialSidebar"
},
{
path: '/documentation/packages/snigdhaos_blackbox',
component: ComponentCreator('/documentation/packages/snigdhaos_blackbox', '3e9'),
exact: true,
sidebar: "tutorialSidebar"
},
{
path: '/documentation/packages/snigdhaos_welcome',
component: ComponentCreator('/documentation/packages/snigdhaos_welcome', 'e46'),
exact: true,
sidebar: "tutorialSidebar"
},
{
path: '/documentation/post_installation/customization',
component: ComponentCreator('/documentation/post_installation/customization', '35c'),

18
.docusaurus/routesChunkNames.json
View File

@@ -186,17 +186,17 @@
},
"content": "content---documentation-markdown-page-393-bce"
},
"/documentation/-d82": {
"/documentation/-df7": {
"__comp": "__comp---theme-docs-root-5-e-9-0b6",
"__context": {
"plugin": "plugin---documentation-99-b-b0a"
}
},
"/documentation/-3e8": {
"/documentation/-a50": {
"__comp": "__comp---theme-doc-version-roota-7-b-5de",
"version": "version---documentation-935-548"
},
"/documentation/-c4e": {
"/documentation/-dbd": {
"__comp": "__comp---theme-doc-roota-94-67a"
},
"/documentation/before_installation/imporatnt_notes-89a": {
@@ -227,6 +227,10 @@
"__comp": "__comp---theme-doc-category-generated-index-page-14-e-640",
"categoryGeneratedIndex": "categoryGeneratedIndex---documentation-category-introductionccd-ede"
},
"/documentation/category/packages-0e6": {
"__comp": "__comp---theme-doc-category-generated-index-page-14-e-640",
"categoryGeneratedIndex": "categoryGeneratedIndex---documentation-category-packages-909-692"
},
"/documentation/category/post-installation-ee0": {
"__comp": "__comp---theme-doc-category-generated-index-page-14-e-640",
"categoryGeneratedIndex": "categoryGeneratedIndex---documentation-category-post-installatione-54-a22"
@@ -311,6 +315,14 @@
"__comp": "__comp---theme-doc-item-178-a40",
"content": "content---documentation-introduction-reporting-bugsdc-8-ae1"
},
"/documentation/packages/snigdhaos_blackbox-3e9": {
"__comp": "__comp---theme-doc-item-178-a40",
"content": "content---documentation-packages-snigdhaos-blackboxbbd-050"
},
"/documentation/packages/snigdhaos_welcome-e46": {
"__comp": "__comp---theme-doc-item-178-a40",
"content": "content---documentation-packages-snigdhaos-welcome-400-dfa"
},
"/documentation/post_installation/customization-35c": {
"__comp": "__comp---theme-doc-item-178-a40",
"content": "content---documentation-post-installation-customization-9-cb-3c6"

2
docs/dev_guide/_category_.json
View File

@@ -1,6 +1,6 @@
{
"label": "Developers Guide",
"position": 7,
"position": 8,
"link": {
"type": "generated-index",
"description": "Troubleshoot"

32
docs/introduction/introduction.md
View File

@@ -5,13 +5,37 @@ slug: /
# Introduction
Let's discover **Docusaurus in less than 5 minutes**.
Snigdha OS is a **light-weight, Powerful & Optimized** Operating System built for **Normal Users & Penetration Testers.**
## Getting Started
## 👉 Features
Get started by **creating a new site**.
As a penetration distribution, [Snigdha OS](https://snigdhaos.org/) serves several features & purposes. Some of them we've mentioned below:
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
**📌 Tailored Toolset**: Penetration testing often requires a specific set of tools for tasks such as network scanning, vulnerability assessment, and exploitation. As a penetration distribution, Snigdha OS comes with collection of pre-installed tools that cater to these needs, ensuring that testers have everything they require readily available.
:::tip
More tools can be installed if the [Online Installation](/installation/online_install) method is selected at the time of Snigdha OS installation. Tools also can be installed after the installation via [Blackbox](/packages/snigdhaos_blackbox).
:::
**📌 Customization and Optimization**: Different penetration testers have different preferences and requirements. Snigdha OS allows you tuning the operating system to maximize performance, minimize resource usage, and streamline workflows, leading to more efficient testing processes.
**📌 Security Focus**: Snigdha OS is hardened and configured with security in mind from the ground up. This includes enabling security features like SELinux or AppArmor, implementing strict firewall rules, and disabling unnecessary services to reduce the attack surface.
**📌 Documentation and Support**: Snigdha OS provieds comprehensive documentation and support resources which can be immensely beneficial for both novice and experienced testers. Clear instructions on [tool](/category/tools) usage, [troubleshooting guides](/category/troubleshoot), and [community forums](https://forum.snigdhaos.org/) can help users navigate challenges and enhance their skills.
:::info
Contributions are always welcome. [Help us to write](/dev_guide/write) better documentation for Snigdha OS.
:::
**📌 Learning**: For educational purposes, Snigdha OS allows users to gain hands-on experience with various tools and techniques in a controlled environment. They can be used in educational settings, workshops, and certification programs to teach aspiring security professionals the fundamentals of penetration testing.
**📌 Consistency and Reproducibility**: As Snigdha OS standardized penetration distribution, it ensures consistency across testing environments, making it easier to replicate and verify results. This is particularly important for organizations conducting regular security assessments or compliance audits where reproducibility is essential.
**📌 Portability and Accessibility**: Snigdha OS can be deployed on a variety of hardware platforms, including [physical machines](/category/installation), [virtual machines](/installation/virtualbox_installation), and cloud instances. This flexibility enables testers to conduct assessments in diverse environments and adapt to different scenarios as needed.
**📌 Legal and Ethical Compliance**: Snigdha OS comes with licenses and usage agreements that clarify the permissible scope of testing activities. By providing a distribution with appropriate legal and ethical guidelines, developers can help ensure that testers adhere to industry standards and regulations.
**📌 Innovation and Experimentation**: We often do some experiments with our new tools, techniques, and methodologies in the field of cybersecurity. Being a part of Snigdha OS, you can help other developers to push the boundaries of existing practices and contribute to advancements in the field.
### What you'll need

9
docs/packages/_category_.json Normal file
View File

@@ -0,0 +1,9 @@
{
"label": "Packages",
"position": 7,
"link": {
"type": "generated-index",
"description": "Troubleshoot"
}
}

4
docs/packages/snigdhaos_blackbox.md Normal file
View File

@@ -0,0 +1,4 @@
---
sidebar_position: 2
---
# Blackbox

4
docs/packages/snigdhaos_welcome.md Normal file
View File

@@ -0,0 +1,4 @@
---
sidebar_position: 1
---
# Welcome