diff --git a/README.md b/README.md index 7ac8299..e412fe2 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,9 @@ Join the [SurfSense Discord](https://discord.gg/ejRNvftDp9) and help shape the f 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. diff --git a/surfsense_web/content/docs/docker-installation.mdx b/surfsense_web/content/docs/docker-installation.mdx index 66bc36d..2a373d0 100644 --- a/surfsense_web/content/docs/docker-installation.mdx +++ b/surfsense_web/content/docs/docker-installation.mdx @@ -1,10 +1,19 @@ --- title: Docker Installation -description: Setting up SurfSense using Docker (Recommended) +description: Setting up SurfSense using Docker 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. @@ -153,6 +162,7 @@ Before you begin, ensure you have: - 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. + ## Next Steps Once your installation is complete, you can start using SurfSense! Navigate to the frontend URL and log in using your Google account. \ No newline at end of file diff --git a/surfsense_web/content/docs/installation.mdx b/surfsense_web/content/docs/installation.mdx index dbb6e52..1a3f455 100644 --- a/surfsense_web/content/docs/installation.mdx +++ b/surfsense_web/content/docs/installation.mdx @@ -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: -## Docker Installation (Preferred) +## Docker Installation - -The recommended way to install SurfSense is using Docker. This method provides a containerized environment with all dependencies pre-configured. +This method provides a containerized environment with all dependencies pre-configured. Less Customization. [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. diff --git a/surfsense_web/content/docs/manual-installation.mdx b/surfsense_web/content/docs/manual-installation.mdx index 561e8d7..477f5ef 100644 --- a/surfsense_web/content/docs/manual-installation.mdx +++ b/surfsense_web/content/docs/manual-installation.mdx @@ -1,10 +1,10 @@ --- title: Manual Installation -description: Setting up SurfSense manually for customized deployments +description: Setting up SurfSense manually for customized deployments (Preferred) 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.