ftp2telegram
ftp2telegram is an FTP server that forwards all uploaded files to preconfigured Telegram
contacts.
It was developed with the specific goal of retrofitting a Telegram interface into older devices or software that
exclusively support FTP upload for file transfer.
Caution: ftp2telegram has not undergone security testing. Avoid exposing it to untrusted networks or the public
internet without implementing proper security measures.
Quick Navigation
Features
- Multiple telegram recipients
- User authorization
- Lightweight and fast (uses
pyftpdlibunderneath) - Easy YAML configuration
Installation
Requires Python version 3.9 or higher and pip.
pip install ftp2telegram
Configuration
To configure ftp2telegram, a configuration file is required. By default, the program looks for it
in ~/.ftp2telegram.conf or /etc/ftp2telegram. Create a sample configuration file with:
ftp2telegram --create-example-config
Example Configuration File
---
ftp:
host: 127.0.0.1
port: 21
telegram:
token: MY_TOKEN
users:
- name: alice
hashed_password: |
$6$Zfgtsr/z3RLvOEKj$D2s4w51WiFiCgyrRD.gxEeMtXxMkgas1OGkSU2c.XMKDdaJ2iOt72yFXM1rvzb7YuoOJ3.i9lMn1qQ7oVEDEm1
telegram_id: 123
- FTP server configuration (
ftp):host: Specifies the FTP server's IP address or hostname.port: Specifies the FTP server's port.
- Telegram configuration (
telegram):token: ReplaceMY_TOKENwith the actual token of your Telegram bot. Create one using BotFather.
- User configuration (
users):- Each user in the list is defined by:
name: The username for FTP server authentication.hashed_password: The SHA512-hashed password of the FTP user. Generate a hashed password usingopenssl passwd -6.telegram_id: The Telegram user ID associated with the FTP user. Obtain it using bots such as @userinfobot.
- Each user in the list is defined by:
Usage
Run the server:
ftp2telegram
File Upload
Log into the server using any of the configured user credentials, and then upload a file. The uploaded file will be automatically sent to the Telegram user linked to the corresponding FTP user in the config file.
Caveats
- There are no subfolders on the FTP server, nor does it allow the creation of any. Thus, all files must be directly uploaded to the root directory.
- Using interactive FTP browsers to access the server may result in errors, as they are restricted from reading the contents of the root directory.
- Since Telegram bots cannot initiate conversations with users, recipients must add the bot and send them a message first before they can receive any files from the bot.
License
ftp2telegram is distributed under the terms of the MIT License.
Metadata
Release files for ftp2telegram 0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ftp2telegram-0.1.tar.gz | 4.5 kB | Without provenance | Details for ftp2telegram-0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ftp2telegram-0.1-py3-none-any.whl | Python 3 | none | any | Details for ftp2telegram-0.1-py3-none-any.whl |
Total release size: 10.3 kB
Release files / ftp2telegram-0.1.tar.gz
| Download URL | ftp2telegram-0.1.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d8863f769f279ec2e3d77e59fa3df7f33a71588ea476eb9854bf6571e6b1d3b
|
|
BLAKE2b-256 checksum How to use checksums |
4675a56c6b58f05bd1d0553fc3fc16e01042062bb1ba3e3ebf11fb6a6e4a4a84
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.6 Linux/6.5.0-4-amd64
|
Release files / ftp2telegram-0.1-py3-none-any.whl
| Download URL | ftp2telegram-0.1-py3-none-any.whl |
|---|---|
| Size | 5.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
198373339a2c9c1223cffc51ccfbfb2e2ec2020ff9a81f71a0bb742bba68500d
|
|
BLAKE2b-256 checksum How to use checksums |
6a79205121211bf9d8c4af9dc3249ace0000c0dfd7407aa62ed6e8fd34fc3b7a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.6 Linux/6.5.0-4-amd64
|
Security for ftp2telegram 0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.