Skip to content

Commit cfa36c7

Browse files
sanjay7178sanjay7178
committed
Add initial configuration, logos, and documentation for BrowserSec
1 parent 2c16f9b commit cfa36c7

File tree

7 files changed

+361
-27
lines changed

7 files changed

+361
-27
lines changed

‎astro.config.mjs‎

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,56 @@ import starlight from '@astrojs/starlight';
66
export default defineConfig({
77
integrations: [
88
starlight({
9-
title: 'My Docs',
10-
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }],
9+
title: 'BrowserSec',
10+
description: 'Open source browser security and detection & response solutions',
11+
// logo: {
12+
// light: './src/assets/logo-light.svg',
13+
// dark: './src/assets/logo-dark.svg',
14+
// },
15+
social: [
16+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/browsersec' },
17+
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/FEGZkmjs' },
18+
{ icon: 'twitter', label: 'Twitter', href: 'https://twitter.com/browsersec' },
19+
],
1120
sidebar: [
21+
{
22+
label: 'Getting Started',
23+
items: [
24+
{ label: 'Introduction', link: '/' },
25+
{ label: 'Quick Start', link: '/guides/quick-start' },
26+
],
27+
},
28+
{
29+
label: 'Products',
30+
items: [
31+
{ label: 'KubeBrowse', link: '/products/kubebrowse' },
32+
{ label: 'Detection Tools', link: '/products/detection-tools' },
33+
],
34+
},
1235
{
1336
label: 'Guides',
1437
items: [
15-
// Each item here is one entry in the navigation menu.
16-
{ label: 'Example Guide', slug: 'guides/example' },
38+
{ label: 'Browser Detection', link: '/guides/browser-detection' },
39+
{ label: 'Security Response', link: '/guides/security-response' },
40+
{ label: 'Example Guide', link: '/guides/example' },
1741
],
1842
},
1943
{
2044
label: 'Reference',
2145
autogenerate: { directory: 'reference' },
2246
},
47+
{
48+
label: 'Community',
49+
items: [
50+
{ label: 'Contributing', link: '/community/contributing' },
51+
{ label: 'Code of Conduct', link: '/community/code-of-conduct' },
52+
],
53+
},
54+
],
55+
customCss: [
56+
'./src/styles/custom.css',
2357
],
2458
}),
2559
],
60+
site: 'https://browsersec.github.io',
2661
});

‎src/assets/logo-dark.svg‎

Lines changed: 8 additions & 0 deletions
Loading

‎src/assets/logo-light.svg‎

Lines changed: 8 additions & 0 deletions
Loading

‎src/content/docs/guides/quick-start.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: Quick Start
3+
description: Get started with BrowserSec tools and technologies
4+
---
5+
<!--
6+
# Getting Started with BrowserSec
7+
8+
This guide will help you get up and running with BrowserSec's open source browser security tools.
9+
10+
## Prerequisites
11+
12+
- Node.js 14 or higher
13+
- Docker and Docker Compose (for KubeBrowse)
14+
- Kubernetes cluster (for production deployments)
15+
16+
## Installation
17+
18+
### 1. Clone the Repository
19+
20+
```bash
21+
git clone https://github.com/browsersec/browsersec-tools.git
22+
cd browsersec-tools
23+
```
24+
25+
### 2. Install Dependencies
26+
27+
```bash
28+
npm install
29+
```
30+
31+
### 3. Configure Your Environment
32+
33+
Create a `.env` file based on the provided example:
34+
35+
```bash
36+
cp .env.example .env
37+
```
38+
39+
Edit the `.env` file to match your environment settings.
40+
41+
### 4. Run the Detection Engine
42+
43+
```bash
44+
npm run detection-engine
45+
```
46+
47+
This will start the browser detection service on port 3000.
48+
49+
## Using the Browser Detection API
50+
51+
Once the detection engine is running, you can use the API to detect browser-based threats:
52+
53+
```javascript
54+
// Example API usage
55+
const response = await fetch('http://localhost:3000/api/analyze', {
56+
method: 'POST',
57+
headers: {
58+
'Content-Type': 'application/json',
59+
},
60+
body: JSON.stringify({
61+
url: 'https://example.com',
62+
options: {
63+
depth: 2,
64+
scanJavaScript: true
65+
}
66+
}),
67+
});
68+
69+
const result = await response.json();
70+
console.log(result);
71+
```
72+
73+
## Setting Up KubeBrowse
74+
75+
For detailed instructions on setting up KubeBrowse, our Kubernetes-based secure browsing solution, see the [KubeBrowse Documentation](/products/kubebrowse).
76+
77+
## Next Steps
78+
79+
- Learn about [Browser Detection](/guides/browser-detection) techniques
80+
- Explore [Security Response](/guides/security-response) automation
81+
- Join our [Discord Community](https://discord.gg/browsersec) to connect with other users and contributors
82+
- Check out the [API Reference](/reference/api) for detailed endpoint information
83+
84+
## Troubleshooting
85+
86+
If you encounter any issues during setup:
87+
88+
1. Check our [FAQ](/reference/faq) for common problems and solutions
89+
2. Search existing [GitHub Issues](https://github.com/browsersec/browsersec-tools/issues)
90+
3. Ask for help in our [Discord Community](https://discord.gg/browsersec)
91+
4. Open a new [GitHub Issue](https://github.com/browsersec/browsersec-tools/issues/new) with detailed information about your problem -->

‎src/content/docs/index.mdx‎

Lines changed: 62 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,75 @@
11
---
2-
title: Welcome to Starlight
3-
description: Get started building your docs site with Starlight.
2+
title: Welcome to BrowserSec
3+
description: Open source browser security and detection & response solutions.
44
template: splash
55
hero:
6-
tagline: Congrats on setting up a new Starlight project!
6+
tagline: Securing browsers with open source detection and response solutions
77
image:
8-
file: ../../assets/houston.webp
8+
file: https://api.iconify.design/mdi:security-network.svg?color=%230284c7&width=140&height=140
9+
alt: BrowserSec security shield icon
910
actions:
10-
- text: Example Guide
11-
link: /guides/example/
12-
icon: right-arrow
13-
- text: Read the Starlight docs
14-
link: https://starlight.astro.build
11+
- text: KubeBrowse
12+
link: https://browsersec.github.io/KubeBrowse
1513
icon: external
16-
variant: minimal
14+
- text: Get Started
15+
link: /guides/quick-start
16+
icon: right-arrow
17+
variant: primary
18+
- text: View on GitHub
19+
link: https://github.com/browsersec
20+
icon: github
21+
variant: secondary
22+
- text: Join our Discord
23+
link: https://discord.gg/browsersec
24+
icon: discord
25+
variant: secondary
1726
---
1827

1928
import { Card, CardGrid } from '@astrojs/starlight/components';
2029

21-
## Next steps
30+
## Browser Security Solutions
2231

2332
<CardGrid stagger>
24-
<Card title="Update content" icon="pencil">
25-
Edit `src/content/docs/index.mdx` to see this page change.
26-
</Card>
27-
<Card title="Add new content" icon="add-document">
28-
Add Markdown or MDX files to `src/content/docs` to create new pages.
29-
</Card>
30-
<Card title="Configure your site" icon="setting">
31-
Edit your `sidebar` and other config in `astro.config.mjs`.
32-
</Card>
33-
<Card title="Read the docs" icon="open-book">
34-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
35-
</Card>
33+
<Card title="Browser Detection" icon="magnifier">
34+
Real-time browser fingerprinting and anomaly detection to identify suspicious activities and potential browser-based threats.
35+
</Card>
36+
<Card title="Threat Response" icon="warning">
37+
Automated incident response workflows to contain and mitigate browser-based attacks before they compromise your systems.
38+
</Card>
39+
<Card title="KubeBrowse" icon="rocket">
40+
Our Kubernetes orchestrator that mitigates phishing attacks from attachments through a secure browser-in-browser sandbox environment.
41+
</Card>
42+
<Card title="Open Source" icon="open-book">
43+
Fully transparent, community-driven security tools that can be audited, extended, and improved by security researchers worldwide.
44+
</Card>
45+
</CardGrid>
46+
47+
## Why BrowserSec?
48+
49+
<CardGrid>
50+
<Card title="Advanced Detection" icon="approve-check">
51+
Our detection engine identifies sophisticated browser-based attacks including zero-days, XSS, and supply chain compromises with minimal false positives.
52+
</Card>
53+
<Card title="Rapid Response" icon="rocket">
54+
Automated containment actions deploy within milliseconds of threat detection, preventing data exfiltration and lateral movement.
55+
</Card>
56+
<Card title="Enterprise Ready" icon="setting">
57+
Designed for scale with support for multi-tenant deployments, role-based access control, and comprehensive audit logging.
58+
</Card>
59+
<Card title="Community Powered" icon="discord">
60+
Join our active community of security researchers and developers to collaborate on next-generation browser security tools.
61+
</Card>
3662
</CardGrid>
63+
64+
## Getting Started
65+
66+
Secure your browsers today with our open source tools. Follow our [Quick Start](/guides/quick-start) guide or check out our [GitHub repository](https://github.com/browsersec) to get started.
67+
68+
<CardGrid>
69+
<Card title="Documentation" icon="document">
70+
Comprehensive guides, API references, and examples to help you implement browser security in your organization.
71+
</Card>
72+
<Card title="Community Support" icon="discord">
73+
Get help from our community of security experts and developers in our Discord server.
74+
</Card>
75+
</CardGrid>

0 commit comments

Comments
 (0)