Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leiweibau committed Nov 13, 2024
1 parent 47993d0 commit a480f3f
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/DEVICE_MANAGEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,20 @@ To edit device information:
- **Comments**: Type any comments for the device

## Session Info
- **Status**: Show device status : On-line / Off-Line
- **Status**: Show device status : Online / Offline
- **First Session**: Date and time of the first connection
- **Last Session**: Date and time of the last connection
- **Last IP**: Last known IP used during the last connection
- **Static IP**: Check this box to identify devices that always use the
same IP

## Network
- **Uplink Target**: A switch, router or similar device created on the network side.
- **Target Port Number**: The port number of this device to which the host is connected.
- **Connection Type**: Self explanatory
- **Link Speed**: Self explanatory


## Events & Alerts config
- **Scan Cycle**: Select the scan cycle: 0, 1'
- **Alert All Events**: Send a notification in each event (connection,
Expand All @@ -46,6 +53,8 @@ To edit device information:
connects and disconnects)*
- **Favorite**: Mark the device as favorite and then it will appears at the
begining of the device list
- **Show on "Presence"**: The device can be hidden on the “Presence” page,
e.g. to increase the overview or because presence tracking is not necessary.

# Random MAC's
<!--- --------------------------------------------------------------------- --->
Expand Down
3 changes: 3 additions & 0 deletions docs/FIRST_START_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ would be ICMP monitoring. However, this cannot be used to detect new devices, on
satellite function, I offer a possibility to place a satellite in such a separate network, which independently executes scans there and
sends the results to a previously configured Pi.Alert instance. These satellites can also be used to detect new devices in separate networks.

The "**4**" (🟪) is a link to the “docs” path in this repository


[Next - Discreet buttons and menus](./guide/001.md)

[Back to Readme](https://github.com/leiweibau/Pi.Alert)
Expand Down
1 change: 1 addition & 0 deletions docs/PIALERT_CONF.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ I would like to give a short explanation to the individual points.
|----------------------|------------------------------------------------------------------------------------------------------|
| REPORT_WEBGUI | Enables/disables the notifications about changes in the network in the web interface. |
| REPORT_WEBGUI_WEBMON | Enables/disables the notifications about changes in the monitored web services in the web interface. |
| REPORT_TO_ARCHIVE | Number of hours after which a report is moved to the archive. The value 0 disables the feature |


#### Mail Reporting
Expand Down

0 comments on commit a480f3f

Please sign in to comment.