Skip to content

Commit c0e8f4d

Browse files
committed
docs: document conda one-click installer
1 parent fe6a888 commit c0e8f4d

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,15 @@ SurfSense provides two installation methods:
151151

152152
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.
153153

154+
3. **Conda One-Click Installer (Experimental)** - Create a ready-to-use Conda environment and install backend/frontend dependencies automatically.
155+
- Requires Miniconda/Anaconda plus Node.js 18+ (for the web UI).
156+
- From the repository root run:
157+
```bash
158+
chmod +x oneclick-conda-install.sh
159+
./oneclick-conda-install.sh
160+
```
161+
- Use `SURFSENSE_ENV_NAME` and `SURFSENSE_PYTHON_VERSION` env vars to customise the Conda environment.
162+
154163
Both installation guides include detailed OS-specific instructions for Windows, macOS, and Linux.
155164

156165
Before installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.net/docs/) including:
@@ -303,4 +312,3 @@ For detailed contribution guidelines, please see our [CONTRIBUTING.md](CONTRIBUT
303312
304313
---
305314
---
306-

0 commit comments

Comments
 (0)