mirror of
https://github.com/franjsco/lscanbot
synced 2025-02-17 20:10:43 +01:00
ef4b2c4d65
Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9. - [Release notes](https://github.com/npm/hosted-git-info/releases) - [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md) - [Commits](https://github.com/npm/hosted-git-info/compare/v2.8.8...v2.8.9) Signed-off-by: dependabot[bot] <support@github.com>
Welcome to lscanbot 📱
A telegram bot to find devices on your LAN.
Install
Step by step
- Install arp-scan package on your GNU/Linux system.
- Configure arp-scan to use without sudo. (
chmod u+s) - Clone this repository on your system.
- Install dependecies with
npm install. - Create new bot with @BotFather on Telegram.
- Insert your API Token (app.token) into
config.json. - Insert your Telegram ID (app.authorizedUsers) into
config.json. - Insert your Network Device (scanner.interface) into
config.json.
Usage
Start server:
npm run start
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 Motorola Moto G6; Frank; AB:CC:MY:MC:AD)
After that, you can scan:
/scan
It will send back the devices connected to your network.
Remove
/remove [MAC Address]
Author
👤 franjsco (Francesco Esposito)
- Website: https://franjsco.github.io/
- Twitter: @franjsco
- Github: @franjsco
Show your support
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2020 franjsco (Francesco Esposito).
This project is GPL--3.0 licensed.
This README was generated with ❤️ by readme-md-generator