Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌌 Void Sentinel — Automated Telegram Cloud Portal

Void Sentinel is a lightweight, event-driven background service for Linux that acts as a direct portal to your Telegram cloud storage. 🌪️✨

Drop any file into your local /void directory, and the Sentinel will instantly upload it to your chosen Telegram channel/group and delete the local copy. Perfect for reclaiming SSD space and building a private, searchable media vault.

🚀 Features

  • Event-Driven: Uses inotify to trigger uploads the second a file is closed (0.0% idle CPU).
  • Auto-Cleanup: Files are deleted locally after successful upload.
  • Standalone Engine: Built with Telethon and optimized for speed.
  • Logging: Keeps a record of every "offering" accepted into the void.

🛠️ Setup

1. Requirements

  • Linux (Arch, Ubuntu, etc.)
  • inotify-tools (e.g., sudo pacman -S inotify-tools)
  • Python 3.8+
  • uv (recommended) or pip

2. Installation

Clone the repository and install dependencies:

git clone https://github.com/your-username/void-sentinel.git
cd void-sentinel
uv venv
source .venv/bin/activate
uv pip install telethon python-dotenv

3. Configuration

Create a .env file in the project root:

API_ID=your_api_id
API_HASH=your_api_hash
CHANNEL_ID=-100xxxxxxxxxx

Note: The account used must be an ADMIN in the target channel to post media.

4. Running the Sentinel

You can run the watcher manually:

./watcher.sh

Or set it up as a systemd user service:

  1. Copy void-sentinel.service to ~/.config/systemd/user/.
  2. Update the ExecStart and WorkingDirectory paths in the service file.
  3. Enable and start:
    systemctl --user daemon-reload
    systemctl --user enable void-sentinel.service --now

🌌 Usage

Move any file to ~/void/ and watch it vanish into your Telegram vault! 🌪️

🖱️ File Manager Integration (Right-Click)

Make the Void even easier to use by adding it to your context menu:

  • Dolphin: Copy context_menu/void-sentinel.desktop to ~/.local/share/kio/servicemenus/.
  • Thunar: Copy the contents of context_menu/thunar-uca-snippet.xml into your ~/.config/Thunar/uca.xml (inside the <actions> tag).

About

A portal for you to upload your transfer your file to a telegram channel or group. It can be used as a file transfer protocol or backup system.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages