mirror of
https://github.com/franjsco/lscanbot
synced 2025-02-16 11:31:37 +01:00
edit README
This commit is contained in:
parent
5824f3abc2
commit
acdc619067
16
README.md
16
README.md
@ -2,18 +2,25 @@
|
||||
|
||||
An opensource telegram bot to find devices on your LAN.
|
||||
|
||||
<img src="screenshot.png" height="400">
|
||||
|
||||
The bot is written in Node.js.
|
||||
|
||||
## Usage
|
||||
|
||||
**lscanbot** scans devices with arp-scan, showing only devices registered in the inventory.
|
||||
|
||||
### Scan
|
||||
Before scanning, you must insert the devices into the inventory (to track it):
|
||||
> /add [Device name] ; [Owner] ; [MAC Address]
|
||||
|
||||
(use `;` to split arguments)
|
||||
|
||||
|
||||
example: (/add My device; Me; AB:CC:MY:MC:AD)
|
||||
|
||||
|
||||
|
||||
After that, you can scan:
|
||||
>/scan
|
||||
|
||||
@ -21,9 +28,12 @@ After that, you can scan:
|
||||
|
||||
It will send back the devices connected to your network.
|
||||
|
||||
### Remove
|
||||
> /remove [MAC Address]
|
||||
|
||||
## Installation
|
||||
|
||||
In order to use this bot is required that the code is hosted on a linux system connected to your LAN (Raspberry Pi would be a good choice)
|
||||
In order to use this bot is required that the code is hosted on a GNU/Linux system connected to your LAN (Raspberry Pi would be a good choice)
|
||||
|
||||
|
||||
### Prerequisites
|
||||
@ -41,7 +51,7 @@ In order to use this bot is required that the code is hosted on a linux system c
|
||||
6. Insert your **token** (app.token) into `config.json`.
|
||||
7. Insert your **TelegramID** (app.authorizedUsers) into `config.json`.
|
||||
8. Insert your **network device** (scanner.interface) into `config.json`.
|
||||
8. Start with`npm start`.
|
||||
8. Start with `npm start`.
|
||||
|
||||
|
||||
### License
|
||||
@ -49,4 +59,4 @@ In order to use this bot is required that the code is hosted on a linux system c
|
||||
GPLv3
|
||||
|
||||
---
|
||||
Made with ❤️ by Francesco Esposito ([@f3sposito](https://github.com/f3sposito))
|
||||
Made with ❤️ by Francesco Esposito ([@frab1t](https://github.com/frab1t))
|
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 476 KiB |
Loading…
x
Reference in New Issue
Block a user