README
¶
FTPServer Telegram connector
Register bot
Read about telegram bots at https://core.telegram.org/bots/tutorial.
Bots are not allowed to contact users. You need to make the first contact from the user for which you want to set up the bot.
Quick start
- Create a bot with @BotFather, let's say with username
my_ftp_bot - Get bot token from BotFather's response, use it as
Tokenin config - Get bot id by run
curl https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getMe - Find
@my_ftp_botin telegram and start chat with it - Send
/startto bot - Run
curl https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdatesand find your chat id in response, use it asChatIDin config
Config example
Please note about shared flag. If it's true then bot instance will be shared between all connections.
If it's false then each user (or even each ftp connection) will have own bot instance and it can lead to telegram bot flood protection.
{
"version": 1,
"accesses": [
{
"fs": "telegram",
"shared": true,
"user": "my_ftp_bot",
"pass": "my_secure_password",
"params": {
"Token": "<YOUR_BOT_TOKEN>",
"ChatID": "<YOUR_CHAT_ID>"
}
}
],
"passive_transfer_port_range": {
"start": 2122,
"end": 2130
}
}
Documentation
¶
Overview ¶
Package telegram provides a telegram access layer
Index ¶
- Variables
- func LoadFs(access *confpar.Access, logger *slog.Logger) (afero.Fs, error)
- type File
- func (f *File) Close() error
- func (f *File) Name() string
- func (f *File) Read(b []byte) (int, error)
- func (f *File) ReadAt(_ []byte, _ int64) (int, error)
- func (f *File) Readdir(_ int) ([]os.FileInfo, error)
- func (f *File) Readdirnames(_ int) ([]string, error)
- func (f *File) Seek(_ int64, _ int) (int64, error)
- func (f *File) Stat() (os.FileInfo, error)
- func (f *File) Sync() error
- func (f *File) Truncate(_ int64) error
- func (f *File) Write(b []byte) (int, error)
- func (f *File) WriteAt(b []byte, off int64) (int, error)
- func (f *File) WriteString(s string) (int, error)
- type FileData
- type FileInfo
- type Fs
- func (m *Fs) Chmod(name string, mode os.FileMode) error
- func (m *Fs) Chown(string, int, int) error
- func (m *Fs) Chtimes(name string, atime, mtime time.Time) error
- func (m *Fs) Create(name string) (afero.File, error)
- func (m *Fs) LstatIfPossible(name string) (os.FileInfo, bool, error)
- func (m *Fs) Mkdir(name string, mode os.FileMode) error
- func (m *Fs) MkdirAll(name string, mode os.FileMode) error
- func (m *Fs) Name() string
- func (m *Fs) Open(name string) (afero.File, error)
- func (m *Fs) OpenFile(name string, flag int, mode os.FileMode) (afero.File, error)
- func (m *Fs) Remove(name string) error
- func (m *Fs) RemoveAll(name string) error
- func (m *Fs) Rename(name string, newname string) error
- func (m *Fs) Stat(name string) (os.FileInfo, error)
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidParameter = errors.New("invalid parameter")
ErrInvalidParameter is returned when a parameter is invalid
var ErrNotFound = errors.New("not found")
ErrNotFound is returned when something is not found
var ErrNotImplemented = errors.New("not implemented")
ErrNotImplemented is returned when something is not implemented
Functions ¶
Types ¶
type File ¶
type File struct {
// Path is the file path
Path string
// Content is the file content
Content []byte
// Fs is the parent Fs
Fs *Fs
// At is the current position in the file
At int64
}
File is the afero.File implementation
func (*File) Readdirnames ¶
Readdirnames is not implemented
type FileData ¶
type FileData struct {
// contains filtered or unexported fields
}
FileData is a simple structure to store file information and implement os.FileInfo interface
type Fs ¶
type Fs struct {
// Bot is the telegram bot instance
Bot *tele.Bot
// ChatID is the telegram chat ID to send files to
ChatID int64
// Logger is the logger, obviously
Logger *slog.Logger
// contains filtered or unexported fields
}
Fs is a write-only afero.Fs implementation using telegram as backend
func (*Fs) LstatIfPossible ¶
LstatIfPossible is not implemented
Source Files