apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-06-06 20:15:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat: update installation documentation with new structure and content for manual installation

Browse source
This commit is contained in:
Anish Sarkar 2026-03-12 21:24:55 +05:30
parent f8558b6c6a
commit 0cf3acc3c1
3 changed files with 21 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
surfsense_web/content/docs/connectors/meta.json
View file

@ -1,6 +1,6 @@
{ {
"title": "Connectors", "title": "Connectors",
"icon": "Cable", "icon": "Unplug",
"pages": [ "pages": [
"google-drive", "google-drive",
"gmail", "gmail",

32
surfsense_web/content/docs/installation.mdx
View file

@ -1,21 +1,27 @@
--- ---
title: Installation title: Installation
description: Current ways to use SurfSense description: How to install SurfSense - Docker or from source
icon: Download icon: Download
--- ---
# Installing SurfSense import { Card, Cards } from 'fumadocs-ui/components/card';
import { Container, Wrench } from 'lucide-react';
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: SurfSense runs as a Python backend + Next.js frontend. You can either spin it up with Docker or set everything up yourself.
## Docker Installation **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.
This method provides a containerized environment with all dependencies pre-configured. Less Customization. <Cards>
<Card
[Learn more about Docker installation](/docs/docker-installation/install-script) icon={<Container />}
title="Docker Installation"
## Manual Installation (Preferred) description="All dependencies pre-configured, up and running in minutes"
href="/docs/docker-installation"
For users who prefer more control over the installation process or need to customize their setup, we also provide manual installation instructions. />
<Card
[Learn more about Manual installation](/docs/manual-installation) icon={<Wrench />}
title="Manual Installation"
description="Set up each component yourself for full control"
href="/docs/manual-installation"
/>
</Cards>

2
surfsense_web/content/docs/manual-installation.mdx
View file

@ -1,6 +1,6 @@
--- ---
title: Manual Installation title: Manual Installation
description: Setting up SurfSense manually for customized deployments (Preferred) description: Setting up SurfSense manually for customized deployments
icon: Wrench icon: Wrench
--- ---