From 5dfc675f78c113465d1522624a9dd970d16d6bfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Wed, 11 Nov 2020 19:06:23 +0100 Subject: readme/todo --- README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 72 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a30ac49..88718de 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,74 @@ A bot to help the board with their meeting agenda and meeting reminders. +## Requirements + +The binary itself depends on: + +- Opus (see TODO) +- OpenSSL + +... as well as the usual suspects: + +``` +$ ldd target/debug/agenda-bot + linux-vdso.so.1 (0x00007ffcc14e5000) + libopus.so.0 => /usr/lib/libopus.so.0 (0x00007fe327d4b000) + libssl.so.1.1 => /usr/lib/libssl.so.1.1 (0x00007fe327cbb000) + libcrypto.so.1.1 => /usr/lib/libcrypto.so.1.1 (0x00007fe3279dd000) + libdl.so.2 => /usr/lib/libdl.so.2 (0x00007fe3279d7000) + libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007fe3279b5000) + libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007fe32799b000) + libc.so.6 => /usr/lib/libc.so.6 (0x00007fe3277d0000) + /lib64/ld-linux-x86-64.so.2 => /usr/lib64/ld-linux-x86-64.so.2 (0x00007fe3290dd000) + libm.so.6 => /usr/lib/libm.so.6 (0x00007fe32768a000) +``` + +It has only been tested on Linux. + +Rust stable is needed to compile. + +## Building + +In order to actually use the bot you need: + +- Somewhere for it to live +- A Slack "classic" bot user +- A Discord bot user +- Permission to add bots to your Slack workspace and Discord server + +Then, either pass the bot tokens as enviornment variables (`DISCORD_API_TOKEN` and +`SLACK_API_TOKEN`), or hard-code them into the binary (**NOT RECOMMENDED** +except for development purposes) by editing `src/discord.rs` and `src/slack.rs`. + +Which channels the messages are sent to is currently specified via either +hard-coded constant values or environment variables (`DISCORD_CHANNEL` and +`SLACK_CHANNEL`). + +The following shows all necessary steps needed to build and run the bot: + +```shell +$ git clone https://github.com/lithekod/agenda-bot.git +$ cd agenda-bot +$ DISCORD_API_TOKEN="" \ # fill + SLACK_API_TOKEN="" \ # in + DISCORD_CHANNEL="" \ # your + SLACK_CHANNEL="" \ # values + cargo run +``` + +## Current (non-)features + +- Messages are sent where they should +- ...but they aren't stored anywhere and can't be summarized. +- No reminders. +- No permissions / trusted users / trusted channels. Please, only private + testing servers for now. + +See the TODO for more planned features. + +## Sales pitch (not yet implemented) + Board members can add items to the agenda by sending a message containing something like @@ -9,10 +77,8 @@ containing something like ``` in either Slack or Discord. The bot sends a confirmation in both Slack -and Discord so everyone can see what's added. - -Every wednesday afternoon (configurable), the day before the meeting, -the bot sends a reminder in both Slack and Discord, as well as the -agenda. +and Discord so everyone can see what's being added. -More features TBD. +Every Wednesday afternoon (configurable) the bot sends a reminder and the agenda +in both Slack and Discord. An additional reminder is sent 1 hour before the +meeting. -- cgit v1.2.1 From aca6d26d3b7d338ce95d88c58a557236024992fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Wed, 11 Nov 2020 19:32:15 +0100 Subject: build without voice --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 88718de..bf5c6d5 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,21 @@ reminders. The binary itself depends on: -- Opus (see TODO) - OpenSSL ... as well as the usual suspects: ``` $ ldd target/debug/agenda-bot - linux-vdso.so.1 (0x00007ffcc14e5000) - libopus.so.0 => /usr/lib/libopus.so.0 (0x00007fe327d4b000) - libssl.so.1.1 => /usr/lib/libssl.so.1.1 (0x00007fe327cbb000) - libcrypto.so.1.1 => /usr/lib/libcrypto.so.1.1 (0x00007fe3279dd000) - libdl.so.2 => /usr/lib/libdl.so.2 (0x00007fe3279d7000) - libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007fe3279b5000) - libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007fe32799b000) - libc.so.6 => /usr/lib/libc.so.6 (0x00007fe3277d0000) - /lib64/ld-linux-x86-64.so.2 => /usr/lib64/ld-linux-x86-64.so.2 (0x00007fe3290dd000) - libm.so.6 => /usr/lib/libm.so.6 (0x00007fe32768a000) + linux-vdso.so.1 (0x00007ffc353fd000) + libssl.so.1.1 => /usr/lib/libssl.so.1.1 (0x00007f58987d2000) + libcrypto.so.1.1 => /usr/lib/libcrypto.so.1.1 (0x00007f58984f4000) + libdl.so.2 => /usr/lib/libdl.so.2 (0x00007f58984ee000) + libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007f58984cc000) + libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007f58984b2000) + libc.so.6 => /usr/lib/libc.so.6 (0x00007f58982e9000) + /lib64/ld-linux-x86-64.so.2 => /usr/lib64/ld-linux-x86-64.so.2 (0x00007f5899b1b000) + libm.so.6 => /usr/lib/libm.so.6 (0x00007f58981a1000) ``` It has only been tested on Linux. -- cgit v1.2.1 From 6129d0089aa32a2c9793b736a6ef0480704948cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Wed, 11 Nov 2020 19:38:05 +0100 Subject: update readme --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bf5c6d5..60e419f 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,7 @@ reminders. ## Requirements -The binary itself depends on: - -- OpenSSL - -... as well as the usual suspects: +The binary itself depends on OpenSSL, as well as the usual suspects (glibc): ``` $ ldd target/debug/agenda-bot @@ -22,9 +18,8 @@ $ ldd target/debug/agenda-bot libm.so.6 => /usr/lib/libm.so.6 (0x00007f58981a1000) ``` -It has only been tested on Linux. - -Rust stable is needed to compile. +It has only been tested on Linux. macOS should work. Rust stable is needed to +compile. ## Building @@ -33,15 +28,15 @@ In order to actually use the bot you need: - Somewhere for it to live - A Slack "classic" bot user - A Discord bot user -- Permission to add bots to your Slack workspace and Discord server +- Necessary permissions to add bots to your Slack workspace and Discord server Then, either pass the bot tokens as enviornment variables (`DISCORD_API_TOKEN` and `SLACK_API_TOKEN`), or hard-code them into the binary (**NOT RECOMMENDED** except for development purposes) by editing `src/discord.rs` and `src/slack.rs`. Which channels the messages are sent to is currently specified via either -hard-coded constant values or environment variables (`DISCORD_CHANNEL` and -`SLACK_CHANNEL`). +hard-coded constant values (again, not recommended, but at least not a security +issue here) or environment variables (`DISCORD_CHANNEL` and `SLACK_CHANNEL`). The following shows all necessary steps needed to build and run the bot: -- cgit v1.2.1 From ff0a5c418dc163798492eaf31f21b7db2ba05b66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Fri, 13 Nov 2020 16:05:00 +0100 Subject: update readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 60e419f..af3bb39 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,15 @@ In order to actually use the bot you need: - A Discord bot user - Necessary permissions to add bots to your Slack workspace and Discord server -Then, either pass the bot tokens as enviornment variables (`DISCORD_API_TOKEN` and -`SLACK_API_TOKEN`), or hard-code them into the binary (**NOT RECOMMENDED** +Then, either pass the bot tokens as enviornment variables (`DISCORD_API_TOKEN` +and `SLACK_API_TOKEN`), or hard-code them into the binary (**NOT RECOMMENDED** except for development purposes) by editing `src/discord.rs` and `src/slack.rs`. Which channels the messages are sent to is currently specified via either hard-coded constant values (again, not recommended, but at least not a security -issue here) or environment variables (`DISCORD_CHANNEL` and `SLACK_CHANNEL`). +issue here) or environment variables (`DISCORD_CHANNEL` and `SLACK_CHANNEL`). If +neither is set the bot will print a list of all channels and their IDs when +starting so you can specify a channel. The following shows all necessary steps needed to build and run the bot: -- cgit v1.2.1 From e5b6afd09283e1fc18cd46914e6af9ba0a101f33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Fri, 13 Nov 2020 16:10:12 +0100 Subject: fixup: update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index af3bb39..4ef3515 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ except for development purposes) by editing `src/discord.rs` and `src/slack.rs`. Which channels the messages are sent to is currently specified via either hard-coded constant values (again, not recommended, but at least not a security issue here) or environment variables (`DISCORD_CHANNEL` and `SLACK_CHANNEL`). If -neither is set the bot will print a list of all channels and their IDs when -starting so you can specify a channel. +any of the two isn't set the bot will print a list of channels and their IDs +when starting so you can specify a channel. The following shows all necessary steps needed to build and run the bot: -- cgit v1.2.1