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

chore: update README and installation documentation to streamline Docker setup and clarify update instructions

Browse source
This commit is contained in:
Anish Sarkar 2026-02-26 05:38:15 +05:30
parent 9ae589b6ba
commit f311a34bf3
2 changed files with 193 additions and 474 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -81,21 +81,26 @@ https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7
Run SurfSense on your own infrastructure for full data control and privacy.
**Quick Start (Docker one-liner):**
```bash
docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 -v surfsense-data:/data --name surfsense --restart unless-stopped ghcr.io/modsetter/surfsense:latest
curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash
```
After starting, open [http://localhost:3000](http://localhost:3000) in your browser.
For Docker Compose and other deployment options, see the [Docker Installation docs](https://www.surfsense.com/docs/docker-installation).
**Update (Automatic updates with Watchtower):**
**Update (recommended — Watchtower):**
```bash
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock nickfedor/watchtower --run-once surfsense
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock nickfedor/watchtower --run-once --label-filter "com.docker.compose.project=surfsense"
```
For Docker Compose, manual installation, and other deployment options, check the [docs](https://www.surfsense.com/docs/).
**Update (manual):**
```bash
cd surfsense # or SurfSense/docker if you used Option 2
docker compose pull && docker compose up -d
```
For manual installation and other deployment options, check the [docs](https://www.surfsense.com/docs/).
### How to Realtime Collaborate (Beta)