danvics/watchyourlan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README upd

Browse source
This commit is contained in:
aceberg 2023-08-03 12:20:44 +07:00
parent 2a9a24e450
commit bf5abef581
2 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/main-docker-all.yml vendored
View file

@ -1,4 +1,4 @@
name: Docker
name: Main-Docker
on:
workflow_dispatch:

7
README.md
View file

@ -9,8 +9,7 @@
![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/aceberg/watchyourlan)
![Docker Pulls](https://img.shields.io/docker/pulls/aceberg/watchyourlan)
Lightweight network IP scanner with web GUI https://github.com/aceberg/WatchYourLAN
Lightweight network IP scanner with web GUI
- [Quick start](https://github.com/aceberg/WatchYourLAN#quick-start)
- [Config](https://github.com/aceberg/WatchYourLAN#config)
- [Config file](https://github.com/aceberg/WatchYourLAN#config-file)
@ -54,7 +53,7 @@ Configuration can be done through config file or environment variables
## Config file
> [!WARNING]
> Config file format has been migrated to YAML in release v1.0.0.
> Config file format has been migrated to YAML in release [v1.0.0](https://github.com/aceberg/WatchYourLAN/releases/tag/1.0.0).
Config file path is `/data/config.yaml`.
All variables could be set there. Example:
@ -75,7 +74,7 @@ timeout: 120
| Key | Description | Default |
| -------- | ----------- | ------- |
| -c | Path to config file | /data/config |
| -c | Path to config file | /data/config.yaml |
| -n | Path to node modules (see below) | "" |
## Local network only