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

docs: enhance Docker installation instructions with Watchtower auto-update option

Browse source
This commit is contained in:
Anish Sarkar 2026-02-21 04:38:01 +05:30
parent 25ab830b4c
commit 6852d026cc
2 changed files with 22 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -89,6 +89,12 @@ docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 -v surfsense-data:/data --n
After starting, open [http://localhost:3000](http://localhost:3000) in your browser. After starting, open [http://localhost:3000](http://localhost:3000) in your browser.
**Update (Automatic updates with Watchtower):**
```bash
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock nickfedor/watchtower --run-once surfsense
```
For Docker Compose, manual installation, and other deployment options, check the [docs](https://www.surfsense.com/docs/). For Docker Compose, manual installation, and other deployment options, check the [docs](https://www.surfsense.com/docs/).
### How to Realtime Collaborate (Beta) ### How to Realtime Collaborate (Beta)

32
surfsense_web/content/docs/docker-installation.mdx
View file

@ -131,7 +131,22 @@ To update SurfSense to the latest version, you can use either of the following m
Your data is safe! The `surfsense-data` volume persists across updates, and database migrations are applied automatically on every startup. Your data is safe! The `surfsense-data` volume persists across updates, and database migrations are applied automatically on every startup.
</Callout> </Callout>
**Option 1: Manual Update** **Option 1: Using Watchtower (one-time auto-update)**
[Watchtower](https://github.com/nicholas-fedor/watchtower) can automatically pull the latest image, stop the old container, and restart it with the same options:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
nickfedor/watchtower \
--run-once surfsense
```
<Callout type="warn">
Use the `nickfedor/watchtower` fork. The original `containrrr/watchtower` is no longer maintained and may fail with newer Docker versions.
</Callout>
**Option 2: Manual Update**
```bash ```bash
# Stop and remove the current container # Stop and remove the current container
@ -148,21 +163,6 @@ docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 \
ghcr.io/modsetter/surfsense:latest ghcr.io/modsetter/surfsense:latest
``` ```
**Option 2: Using Watchtower (one-time auto-update)**
[Watchtower](https://github.com/nicholas-fedor/watchtower) can automatically pull the latest image, stop the old container, and restart it with the same options:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
nickfedor/watchtower \
--run-once surfsense
```
<Callout type="warn">
Use the `nickfedor/watchtower` fork. The original `containrrr/watchtower` is no longer maintained and may fail with newer Docker versions.
</Callout>
If you used Docker Compose for the quick start, updating is simpler: If you used Docker Compose for the quick start, updating is simpler:
```bash ```bash