From 0a11de9e956f0896cac02538fba32b664d348fb3 Mon Sep 17 00:00:00 2001 From: Aki-07 Date: Thu, 16 Oct 2025 20:10:17 +0530 Subject: [PATCH] feat: Prioritize Conda one-click installer in README Reordered the installation options in README.md to highlight the Conda one-click installer as the recommended method for most users. This change aims to clarify and streamline the setup process. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 89164ca55..507075ee8 100644 --- a/README.md +++ b/README.md @@ -139,19 +139,9 @@ Check out our public roadmap and contribute your ideas or feedback: ### Installation Options -SurfSense provides two installation methods: +SurfSense provides multiple installation methods: -1. **[Docker Installation](https://www.surfsense.net/docs/docker-installation)** - The easiest way to get SurfSense up and running with all dependencies containerized. - - Includes pgAdmin for database management through a web UI - - Supports environment variable customization via `.env` file - - Flexible deployment options (full stack or core services only) - - No need to manually edit configuration files between environments - - See [Docker Setup Guide](DOCKER_SETUP.md) for detailed instructions - - For deployment scenarios and options, see [Deployment Guide](DEPLOYMENT_GUIDE.md) - -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. - -3. **Conda One-Click Installer (Experimental)** - Create a ready-to-use Conda environment and install backend/frontend dependencies automatically. +1. **Conda One-Click Installer (Recommended for most users)** - Create a ready-to-use Conda environment and install backend/frontend dependencies automatically. - Requires Miniconda/Anaconda plus Node.js 18+ (for the web UI). - From the repository root run: ```bash @@ -160,6 +150,16 @@ SurfSense provides two installation methods: ``` - Use `SURFSENSE_ENV_NAME` and `SURFSENSE_PYTHON_VERSION` env vars to customise the Conda environment. +2. **[Docker Installation](https://www.surfsense.net/docs/docker-installation)** - The easiest way to get SurfSense up and running with all dependencies containerized. + - Includes pgAdmin for database management through a web UI + - Supports environment variable customization via `.env` file + - Flexible deployment options (full stack or core services only) + - No need to manually edit configuration files between environments + - See [Docker Setup Guide](DOCKER_SETUP.md) for detailed instructions + - For deployment scenarios and options, see [Deployment Guide](DEPLOYMENT_GUIDE.md) + +3. **[Manual Installation](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. Before installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.net/docs/) including: