Skip to content

Commit 0cf3acc

Browse files
committed
feat: update installation documentation with new structure and content for manual installation
1 parent f8558b6 commit 0cf3acc

File tree

3 files changed

+24
-18
lines changed

3 files changed

+24
-18
lines changed

surfsense_web/content/docs/connectors/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"title": "Connectors",
3-
"icon": "Cable",
3+
"icon": "Unplug",
44
"pages": [
55
"google-drive",
66
"gmail",
Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
---
22
title: Installation
3-
description: Current ways to use SurfSense
3+
description: How to install SurfSense - Docker or from source
44
icon: Download
55
---
66

7-
# Installing SurfSense
8-
9-
There are two ways to install SurfSense, but both require the repository to be cloned first. Clone [SurfSense](https://github.com/MODSetter/SurfSense) and then:
10-
11-
## Docker Installation
12-
13-
This method provides a containerized environment with all dependencies pre-configured. Less Customization.
14-
15-
[Learn more about Docker installation](/docs/docker-installation/install-script)
16-
17-
## Manual Installation (Preferred)
18-
19-
For users who prefer more control over the installation process or need to customize their setup, we also provide manual installation instructions.
20-
21-
[Learn more about Manual installation](/docs/manual-installation)
7+
import { Card, Cards } from 'fumadocs-ui/components/card';
8+
import { Container, Wrench } from 'lucide-react';
9+
10+
SurfSense runs as a Python backend + Next.js frontend. You can either spin it up with Docker or set everything up yourself.
11+
12+
**Not sure which to pick?** Docker gets you up and running fastest. Go manual if you want to build SurfSense with us or need full control over the stack.
13+
14+
<Cards>
15+
<Card
16+
icon={<Container />}
17+
title="Docker Installation"
18+
description="All dependencies pre-configured, up and running in minutes"
19+
href="/docs/docker-installation"
20+
/>
21+
<Card
22+
icon={<Wrench />}
23+
title="Manual Installation"
24+
description="Set up each component yourself for full control"
25+
href="/docs/manual-installation"
26+
/>
27+
</Cards>

surfsense_web/content/docs/manual-installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Manual Installation
3-
description: Setting up SurfSense manually for customized deployments (Preferred)
3+
description: Setting up SurfSense manually for customized deployments
44
icon: Wrench
55
---
66

0 commit comments

Comments
 (0)