apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-04-25 00:36:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Minor modifications to documentation

Browse source
This commit is contained in:
Manoj Aggarwal 2026-01-07 13:36:15 -08:00
parent 1614821dd9
commit 31383ad0d7
2 changed files with 61 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
surfsense_backend/pyproject.toml
View file

@ -2,7 +2,6 @@
name = "surf-new-backend"
version = "0.0.10"
description = "SurfSense Backend"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
"alembic>=1.13.0",
@ -153,3 +152,12 @@ line-ending = "auto"
known-first-party = ["app"]
force-single-line = false
combine-as-imports = true
[tool.setuptools.packages.find]
where = ["."]
include = ["app*"]
exclude = ["alembic*"]
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

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

@ -234,7 +234,7 @@ redis-cli ping
In a new terminal window, start the Celery worker to handle background tasks:
**Linux/macOS/Windows:**
**If using uv:**
```bash
# Make sure you're in the surfsense_backend directory
@ -244,13 +244,31 @@ cd surfsense_backend
uv run celery -A celery_worker.celery_app worker --loglevel=info --concurrency=1 --pool=solo
```
**If using pip/venv:**
```bash
# Make sure you're in the surfsense_backend directory
cd surfsense_backend
# Activate virtual environment
source .venv/bin/activate # Linux/macOS
# OR
.venv\Scripts\activate # Windows
# Start Celery worker
celery -A celery_worker.celery_app worker --loglevel=info --concurrency=1 --pool=solo
```
**Optional: Start Flower for monitoring Celery tasks:**
In another terminal window:
```bash
# Start Flower (Celery monitoring tool)
# If using uv
uv run celery -A celery_worker.celery_app flower --port=5555
# If using pip/venv (activate venv first)
celery -A celery_worker.celery_app flower --port=5555
```
Access Flower at [http://localhost:5555](http://localhost:5555) to monitor your Celery tasks.
@ -259,7 +277,7 @@ Access Flower at [http://localhost:5555](http://localhost:5555) to monitor your
In another new terminal window, start Celery Beat to enable periodic tasks (like scheduled connector indexing):
**Linux/macOS/Windows:**
**If using uv:**
```bash
# Make sure you're in the surfsense_backend directory
@ -269,13 +287,28 @@ cd surfsense_backend
uv run celery -A celery_worker.celery_app beat --loglevel=info
```
**If using pip/venv:**
```bash
# Make sure you're in the surfsense_backend directory
cd surfsense_backend
# Activate virtual environment
source .venv/bin/activate # Linux/macOS
# OR
.venv\Scripts\activate # Windows
# Start Celery Beat
celery -A celery_worker.celery_app beat --loglevel=info
```
**Important**: Celery Beat is required for the periodic indexing functionality to work. Without it, scheduled connector tasks won't run automatically. The schedule interval can be configured using the `SCHEDULE_CHECKER_INTERVAL` environment variable.
### 6. Run the Backend
Start the backend server:
**Linux/macOS/Windows:**
**If using uv:**
```bash
# Run without hot reloading
@ -285,6 +318,21 @@ uv run main.py
uv run main.py --reload
```
**If using pip/venv:**
```bash
# Activate virtual environment if not already activated
source .venv/bin/activate # Linux/macOS
# OR
.venv\Scripts\activate # Windows
# Run without hot reloading
python main.py
# Or with hot reloading for development
python main.py --reload
```
If everything is set up correctly, you should see output indicating the server is running on `http://localhost:8000`.
## Frontend Setup