https://github.com/losparviero/tailscale-telegram-bot
https://github.com/losparviero/tailscale-telegram-bot
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/losparviero/tailscale-telegram-bot
- Owner: losparviero
- License: agpl-3.0
- Created: 2023-03-01T11:34:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-11T07:58:57.000Z (over 2 years ago)
- Last Synced: 2025-01-12T16:13:09.787Z (9 months ago)
- Language: JavaScript
- Homepage: https://tl-zub.vercel.app
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tailscale Telegram Bot
Get devices and information on your Tailnet in Telegram!
### Install
1. Clone git repo.
2. Run ```npm i``` in project folder. This will install the required dependencies.
3. Populate .env file with bot token, bot dev ID, tailnet & Tailscale API key.
#### Bot token can be obtained from @BotFather.
#### Bot dev ID is to prevent unauthorized use.
#### Tailnet is your organization name. Get it from [here](https://login.tailscale.com/admin/settings/general).
#### API key can be obtained from Tailscale.
4. Run ```node bot``` to start the bot.
#### It's advisable to run the bot using PM2 or any startup manager for persistent execution, as this ensures you won't have to have the terminal open. You can set up auto-start as well. Or pass a cron job.
### Uninstall
1. Use ```rm -rf```.
*Note:* If you're unfamiliar with this command, delete project folder from file explorer.
### Mechanism
The bot uses the Tailscale API.
Copyright (C) 2023 Zubin
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .