2018-09-24 21:21:53 +02:00
|
|
|
# lscanbot
|
|
|
|
|
|
2018-09-24 21:24:31 +02:00
|
|
|
An opensource telegram bot to find devices on your LAN.
|
2018-09-24 21:21:53 +02:00
|
|
|
|
2019-02-12 22:52:46 +01:00
|
|
|
<img src="screenshot.png" height="400">
|
|
|
|
|
|
2018-09-24 21:24:31 +02:00
|
|
|
The bot is written in Node.js.
|
2018-09-24 21:21:53 +02:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
**lscanbot** scans devices with arp-scan, showing only devices registered in the inventory.
|
|
|
|
|
|
2019-02-12 22:52:46 +01:00
|
|
|
### Scan
|
2018-09-24 21:21:53 +02:00
|
|
|
Before scanning, you must insert the devices into the inventory (to track it):
|
|
|
|
|
> /add [Device name] ; [Owner] ; [MAC Address]
|
|
|
|
|
|
|
|
|
|
(use `;` to split arguments)
|
|
|
|
|
|
|
|
|
|
|
2019-02-12 22:52:46 +01:00
|
|
|
example: (/add My device; Me; AB:CC:MY:MC:AD)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-09-24 21:21:53 +02:00
|
|
|
After that, you can scan:
|
|
|
|
|
>/scan
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
It will send back the devices connected to your network.
|
|
|
|
|
|
2019-02-12 22:52:46 +01:00
|
|
|
### Remove
|
|
|
|
|
> /remove [MAC Address]
|
|
|
|
|
|
2018-09-24 21:21:53 +02:00
|
|
|
## Installation
|
|
|
|
|
|
2019-02-12 22:52:46 +01:00
|
|
|
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)
|
2018-09-24 21:21:53 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
- Node.js
|
|
|
|
|
- npm
|
|
|
|
|
- GNU/Linux
|
|
|
|
|
|
|
|
|
|
### Step by step
|
|
|
|
|
1. Install **arp-scan** package on your linux system.
|
|
|
|
|
2. Configure arp-scan to use without sudo.
|
|
|
|
|
(`chmod u+s`)
|
|
|
|
|
3. Clone this repository on your system.
|
2018-09-24 21:26:40 +02:00
|
|
|
4. Install dependecies with `npm install`.
|
2018-09-24 21:21:53 +02:00
|
|
|
5. Create new bot with BotFather on Telegram.
|
|
|
|
|
6. Insert your **token** (app.token) into `config.json`.
|
|
|
|
|
7. Insert your **TelegramID** (app.authorizedUsers) into `config.json`.
|
2018-09-24 21:27:27 +02:00
|
|
|
8. Insert your **network device** (scanner.interface) into `config.json`.
|
2019-02-12 22:52:46 +01:00
|
|
|
8. Start with `npm start`.
|
2018-09-24 21:21:53 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### License
|
|
|
|
|
|
|
|
|
|
GPLv3
|
|
|
|
|
|
|
|
|
|
---
|
2020-03-01 23:35:34 +01:00
|
|
|
Made with ❤️ by Francesco Esposito ([@franjsco](https://github.com/franjsco))
|
