broonie

README

Broonie

Broonie(why this name?) is a Telegram bots that automatically downloads photos and videos in real-time from conversations where the bot has been added to. This makes it very convenient to save all the memories from family Telegram groups and expose them on Plex for example.

Usage

You first need to create a bot on Telegram to retrieve a token.

Then, you need to create your configuration file:

$> cp config.json.sample config.json

Configure it with your own values. You can only run one instance of the bot in parallel. So if you want to handle multiple Telegram groups, you have to define several entries in the config file.

Then run the application:

$> go run cmd/broonie/main.go

You should expect to see no error. Enjoy!

Docker

A Docker image is also available:

docker run -v config.json:/app/config.json:ro arkan/broonie:latest

Copyright

See the LICENSE (MIT) file for more details.

Documentation

Index

• type Client
  • func NewClient(configPath string) (*Client, error)
  • func (c *Client) HandleNewUploads(fn func(filename string, url string, rule *ConfigRule) error) error
• type Config
• type ConfigRule

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client ...

func NewClient

func NewClient(configPath string) (*Client, error)

NewClient ...

func (*Client) HandleNewUploads

func (c *Client) HandleNewUploads(fn func(filename string, url string, rule *ConfigRule) error) error

HandleNewUploads ...

type Config

type Config struct {
	Token string
	Debug bool
	Rules []*ConfigRule
}

Config contains the bot configuration.

type ConfigRule

type ConfigRule struct {
	Group               string
	SkipTelegramChannel bool
	Directory           string
	SubDirectory        string
}

ConfigRule contains a channel configuration.