vrr/SurfSense
2
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2025-09-02 02:29:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: docs

Browse source
This commit is contained in:
DESKTOP-RTLN3BA\$punk 2025-04-24 19:50:39 -07:00
parent d16794a782
commit ab2ffbb42b
4 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -76,9 +76,9 @@ Join the [SurfSense Discord](https://discord.gg/ejRNvftDp9) and help shape the f
SurfSense provides two installation methods: SurfSense provides two installation methods:
1. **[Docker Installation (Recommended)](https://www.surfsense.net/docs/docker-installation)** - The easiest way to get SurfSense up and running with all dependencies containerized. 1. **[Docker Installation](https://www.surfsense.net/docs/docker-installation)** - The easiest way to get SurfSense up and running with all dependencies containerized. Less Customization.
2. **[Manual Installation](https://www.surfsense.net/docs/manual-installation)** - For users who prefer more control over their setup or need to customize their deployment. 2. **[Manual Installation (Recommended)](https://www.surfsense.net/docs/manual-installation)** - For users who prefer more control over their setup or need to customize their deployment.
Both installation guides include detailed OS-specific instructions for Windows, macOS, and Linux. Both installation guides include detailed OS-specific instructions for Windows, macOS, and Linux.

14
surfsense_web/content/docs/docker-installation.mdx
View file

@ -1,10 +1,19 @@
--- ---
title: Docker Installation title: Docker Installation
description: Setting up SurfSense using Docker (Recommended) description: Setting up SurfSense using Docker
full: true full: true
--- ---
## Known Limitations
# Docker Installation (Recommended) ⚠️ **Important Note:** Currently, the following features have limited functionality when running in Docker:
- **Ollama integration:** Local Ollama models do not work when running SurfSense in Docker. Please use other LLM providers like OpenAI or Gemini instead.
- **Web crawler functionality:** The web crawler feature currently doesn't work properly within the Docker environment.
We're actively working to resolve these limitations in future releases.
# Docker Installation
This guide explains how to run SurfSense using Docker Compose, which is the preferred and recommended method for deployment. This guide explains how to run SurfSense using Docker Compose, which is the preferred and recommended method for deployment.
@ -153,6 +162,7 @@ Before you begin, ensure you have:
- For frontend dependency issues, check the `Dockerfile` in the frontend directory. - For frontend dependency issues, check the `Dockerfile` in the frontend directory.
- **Windows-specific:** If you encounter line ending issues (CRLF vs LF), configure Git to handle line endings properly with `git config --global core.autocrlf true` before cloning the repository. - **Windows-specific:** If you encounter line ending issues (CRLF vs LF), configure Git to handle line endings properly with `git config --global core.autocrlf true` before cloning the repository.
## Next Steps ## Next Steps
Once your installation is complete, you can start using SurfSense! Navigate to the frontend URL and log in using your Google account. Once your installation is complete, you can start using SurfSense! Navigate to the frontend URL and log in using your Google account.

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

@ -8,14 +8,13 @@ full: true
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: 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:
## Docker Installation (Preferred) ## Docker Installation
This method provides a containerized environment with all dependencies pre-configured. Less Customization.
The recommended way to install SurfSense is using Docker. This method provides a containerized environment with all dependencies pre-configured.
[Learn more about Docker installation](/docs/docker-installation) [Learn more about Docker installation](/docs/docker-installation)
## Manual Installation ## Manual Installation (Preferred)
For users who prefer more control over the installation process or need to customize their setup, we also provide manual installation instructions. For users who prefer more control over the installation process or need to customize their setup, we also provide manual installation instructions.

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

@ -1,10 +1,10 @@
--- ---
title: Manual Installation title: Manual Installation
description: Setting up SurfSense manually for customized deployments description: Setting up SurfSense manually for customized deployments (Preferred)
full: true full: true
--- ---
# Manual Installation # Manual Installation (Preferred)
This guide provides step-by-step instructions for setting up SurfSense without Docker. This approach gives you more control over the installation process and allows for customization of the environment. This guide provides step-by-step instructions for setting up SurfSense without Docker. This approach gives you more control over the installation process and allows for customization of the environment.