From 68f17f04cc48904abd8b7cdc527410bb5baad2fb Mon Sep 17 00:00:00 2001 From: Johan Mulder Date: Thu, 19 Apr 2018 23:02:49 +0200 Subject: Added documentation in README.md. Moved changelog to CHANGELOG.md --- CHANGELOG.md | 30 ++++++++++++++++++++++ README.md | 82 ++++++++++++++++++++++++++++++++++++++++++------------------ 2 files changed, 88 insertions(+), 24 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..52e233c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +## 2018-04-19 23:01:49 (friek) +- updated README +- moved changelog to CHANGELOG.md + +## 2018-04-19 14:17:23 +- use alpine 3.7 +- add slack-libpurple + +## 2017-09-18 12:30:45 +- trigger rebuild related to https://github.com/bitlbee/bitlbee-facebook/issues/151 + +## 2017-07-30 20:52:55 +- adding purple-hangouts + +## 2017-07-29 18:14:51 +- using alpine 3.6 +- remove libpurple-ymsg +- adding telegram-purple + +## 2017-04-21 12:57:42 +- trigger rebuild + +## 2017-04-04 12:59:58 +- trigger rebuild cause of facebook fix + +## 2017-03-30 11:43:46 +- trigger rebuild cause of facebook fix + diff --git a/README.md b/README.md index 4ad0caa..f567bc5 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,60 @@ # docker-bitlbee-libpurple -## 2018-04-19 14:17:23 -- use alpine 3.7 -- add slack-libpurple - -## 2017-09-18 12:30:45 -- trigger rebuild related to https://github.com/bitlbee/bitlbee-facebook/issues/151 - -## 2017-07-30 20:52:55 -- adding purple-hangouts - -## 2017-07-29 18:14:51 -- using alpine 3.6 -- remove libpurple-ymsg -- adding telegram-purple - -## 2017-04-21 12:57:42 -- trigger rebuild - -## 2017-04-04 12:59:58 -- trigger rebuild cause of facebook fix - -## 2017-03-30 11:43:46 -- trigger rebuild cause of facebook fix - +This docker image includes bitlbee with a bunch of useful plugins, the most +significant being the [libpurple Slack plugin](https://github.com/dylex/slack-libpurple). + +As Slack is turning off its IRC gateway on May 15 2018, now is the time to +spin up your own docker image and start using bitlbee instead. + +## Building and running the image +Build the image and tag it: +```bash +docker build -t bitlbee:latest . +``` + +Then run it: +```bash +docker run -p 6667:6667 --name bitlbee -v /local/path/to/configurations:/var/lib/bitlbee --restart=always --detach bitlbee:latest +``` + +The local path to the configurations will contain the configuration as saved by +bitlbee. It is advisable to do so, as you're configuration will be gone when +the docker image gets deleted. + +## Setting up a Slack account +Connect with your IRC client to the host running the image. Then register with a password in the &bitlbee channel: +``` +/join &bitlbee +register +``` + +Then, go to [the Slack legacy token site](https://api.slack.com/custom-integrations/legacy-tokens) to acquire +an API token, which is necessary in order to log in. + +Copy the token, register your slack account in bitlbee and enable the account: +``` +account add slack yourusername@whatever.slack.com thetoken +account on +``` + +This should log your account in right away: +``` +<@root> Trying to get all accounts connected... +<@root> slack - Logging in: Requesting RTM +<@root> slack - Logging in: Connecting to RTM +<@root> slack - Logging in: RTM Connected +<@root> slack - Logging in: Loading Users +<@root> slack - Logging in: Loading conversations +<@root> slack - Logging in: Logged in +``` + +By default, none of the channels you normally reside in will be joined. To join them, you first need to add them: +``` +<@you> chat add slack general +<@root> Chatroom successfully added. +``` + +Don't add the leading #. Adding private channels works the same way as public channels, both without the leading #. +Now, join the channel with /join #channnelname and you'll be good to go. + +will add channel general, -- cgit v1.2.3 From f5e51e6f6bcc04f52457d6ace34c42eb41d8f2ad Mon Sep 17 00:00:00 2001 From: Johan Mulder Date: Thu, 19 Apr 2018 23:04:44 +0200 Subject: Deleted run away sentence. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f567bc5..60202f8 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,3 @@ By default, none of the channels you normally reside in will be joined. To join Don't add the leading #. Adding private channels works the same way as public channels, both without the leading #. Now, join the channel with /join #channnelname and you'll be good to go. -will add channel general, -- cgit v1.2.3 From badb9c84d965fc424dd6a5c1d798d4c11abe154a Mon Sep 17 00:00:00 2001 From: Johan Mulder Date: Thu, 19 Apr 2018 23:12:12 +0200 Subject: Fixed spelling error --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60202f8..d30bbd6 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,12 @@ docker build -t bitlbee:latest . Then run it: ```bash -docker run -p 6667:6667 --name bitlbee -v /local/path/to/configurations:/var/lib/bitlbee --restart=always --detach bitlbee:latest +docker run -p 6667:6667 --name bitlbee -v /local/path/to/configurations:/var/lib/bitlbee \ + --restart=always --detach bitlbee:latest ``` The local path to the configurations will contain the configuration as saved by -bitlbee. It is advisable to do so, as you're configuration will be gone when +bitlbee. It is advisable to do so, as your configuration will be gone when the docker image gets deleted. ## Setting up a Slack account -- cgit v1.2.3