mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-04-25 00:36:31 +02:00
2b7465cdaa
Remove all Electric SQL client code, Docker service, env vars, CI build args, install scripts, and documentation. Feature hooks that depend on Electric are intentionally left in place to be rewritten with Rocicorp Zero in subsequent commits. Deleted: - lib/electric/ (client.ts, context.ts, auth.ts, baseline.ts) - ElectricProvider.tsx - docker/scripts/init-electric-user.sh - content/docs/how-to/electric-sql.mdx Cleaned: - package.json (4 @electric-sql/* deps) - app/layout.tsx, UserDropdown.tsx, LayoutDataProvider.tsx - docker-compose.yml, docker-compose.dev.yml - Dockerfile, docker-entrypoint.js - .env.example (frontend, docker, backend) - CI workflows, install scripts, docs
40 lines
1.3 KiB
Text
40 lines
1.3 KiB
Text
---
|
|
title: One-Line Install Script
|
|
description: One-command installation of SurfSense using Docker
|
|
---
|
|
|
|
Downloads the compose files, generates a `SECRET_KEY`, starts all services, and sets up [Watchtower](https://github.com/nicholas-fedor/watchtower) for automatic daily updates.
|
|
|
|
**Prerequisites:** [Docker Desktop](https://www.docker.com/products/docker-desktop/) must be installed and running.
|
|
|
|
### For Linux/macOS users:
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash
|
|
```
|
|
|
|
### For Windows users (PowerShell):
|
|
|
|
```powershell
|
|
irm https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.ps1 | iex
|
|
```
|
|
|
|
This creates a `./surfsense/` directory with `docker-compose.yml` and `.env`, then runs `docker compose up -d`.
|
|
|
|
To skip Watchtower (e.g. in production where you manage updates yourself):
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash -s -- --no-watchtower
|
|
```
|
|
|
|
To customise the check interval (default 24h), use `--watchtower-interval=SECONDS`.
|
|
|
|
---
|
|
|
|
## Access SurfSense
|
|
|
|
After starting, access SurfSense at:
|
|
|
|
- **Frontend**: [http://localhost:3929](http://localhost:3929)
|
|
- **Backend API**: [http://localhost:8929](http://localhost:8929)
|
|
- **API Docs**: [http://localhost:8929/docs](http://localhost:8929/docs)
|