miniporte

package module

v0.0.0-...-dcdb75e Latest Latest Go to latest Published: Apr 1, 2016 License: BSD-2-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/oz/miniporte

Links

Open Source Insights

README ¶

Miniporte

This is a small IRC bot to save links shared on IRC channels onto various online services.

Every link is logged using the provided tags. When no tag is provided, or if the #private tag is used, the link is saved privately (for services that support it).

Additionally, the IRC channel, and user's nick are used as tags too.

Installation

$ go get github.com/oz/miniporte
$ go install github.com/oz/miniporte/cmd/miniporte

Configuration

The bot is configured through the following environment variables.

IRC_SERVER IRC server, defaults to irc.freenode.net:7000 (SSL is always on).
IRC_NICK IRC nick, defaults to miniporte.
IRC_NAME IRC name, defaults to Mini-Porte.
IRC_IDENT IRC ident name, defaults to MiniPorteIRCBot.
IRC_CHANS comma-separated list of IRC channels, defaults to #minibots.

In order to use Epistoli's cute API to build newsletters from the links shared on IRC, you will also need:

EPISTOLI_TOKEN API token to post links,
EPISTOLI_LETTER The newsletter name where links are posted.

Usage

Just launch the miniporte program if the defaults are fine. Check the -help flag for more options.

Todo

Lots. 💪

Background

This is maybe boring, TLDR: a simpler version of another proprietary IRC bot.

It all started at af83, where a Cinch-based bot would log links from IRC to a Delicious account (for later processing). The bot did many things, talked to Jenkins, Trello, etc.

Well it did a lot of other (possibly) useful things in those days of hardware hacking, and software exploration, and fun. It was called Mr. Porte (Mr. Door opened the electronic front-door lock), and it is now offline.

This project, however, is content with the logging of links (URIs really) onto your favourite online service. Hence its name miniporte, tiny-door, as a tribute to a long gone ancestor. 🚪

License

MIT.

Documentation ¶

Index ¶

type Bot
- func New(server, nick, name, ident string, chans []string) *Bot
- func (b *Bot) Connect() error
- func (b *Bot) Run()

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Bot ¶

type Bot struct {
	Chans  []string
	Config *irc.Config
	Client *irc.Conn
	Ctl    (chan string)
}

Bot stores the state of our bot, and its configuration.

func New ¶

func New(server, nick, name, ident string, chans []string) *Bot

New initializes a new Bot, ready to connect to IRC.

func (*Bot) Connect ¶

func (b *Bot) Connect() error

Connect connect the bot to an IRC server.

func (*Bot) Run ¶

func (b *Bot) Run()

Source Files ¶

View all Source files

bot.go

Directories ¶

Path	Synopsis
cmd
miniporte
delicious
epistoli
link

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL