betapictoris / owl

πŸ’¬ A link for Discord and IRC written in Python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Owl Docker Image CI

Warning

This project has been abandoned! I may end up picking it up again in the future but don't expect new features or updates.

An open source Discord - IRC link written in Python.

Owl

🌠 To-do

  • Discord
  • IRC
  • Slack
  • Microsoft Teams
  • Matrix
  • Mentions
  • TLS IRC
  • IRC NickServ authentication
  • Docker support
  • Example Docker compose
  • Publish Docker container on Docker Hub or GitHub

πŸ”§ Configuration

Set these environment variables:

Variable Description Values
IrcEnabled Enable the IRC client True or False
IrcServer IRC server for connection A hostname or IP address
IrcPort IRC port The port for the IRC server (non-TLS)
IrcChannel IRC channel to read/send from/to An IRC channel (Like #linux)
IrcBotnick Nick name for the bot A valid IRC nick
DiscordEnabled Enable the Discord client True or False
DiscordToken Discord bot token A valid token for a Discord bot
DiscordWebhook Discord webhook URL (used for sending messages to the Discord server) A URL
DiscordGuild Discord guild to send/read messages to/from A Discord Snowflake
DiscordChannel Discord channel to send/read message to/from Also a Discord Snowflake

πŸ”¨ Installation

Using Docker

Using Docker Hub

docker pull betapictoris/owl
docker run -e [YOUR CONFIG] -d betapictoris/owl

Instead of running off the command line it is recommened to use a compose file

Building the container

git clone git@github.com:BetaPictoris/owl.git   # Clone the repo
cd owl                                          # Change your working directory into the
docker build --tag owl:build                    # Build the Docker image. 
docker run -e [YOUR CONFIG] -d owl:build        # Run the Docker container. 

Manual

git clone git@github.com:BetaPictoris/owl.git   # Clone the repo
cd owl/src                                      # Change your working directory into the source directory 
python3 Owl.py                                  # Run the script

wiki

About

πŸ’¬ A link for Discord and IRC written in Python


Languages

Language:Python 97.7%Language:Dockerfile 2.3%