Merge pull request #1 from friek/master

Added documentation
This commit is contained in:
ezkrg
2018-04-20 10:58:54 +02:00
committed by GitHub
2 changed files with 81 additions and 17 deletions

30
CHANGELOG.md Normal file
View File

@@ -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

View File

@@ -1,26 +1,60 @@
# docker-bitlbee-libpurple
## 2018-04-19 14:17:23
- use alpine 3.7
- add slack-libpurple
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).
## 2017-09-18 12:30:45
- trigger rebuild related to https://github.com/bitlbee/bitlbee-facebook/issues/151
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.
## 2017-07-30 20:52:55
- adding purple-hangouts
## Building and running the image
Build the image and tag it:
```bash
docker build -t bitlbee:latest .
```
## 2017-07-29 18:14:51
- using alpine 3.6
- remove libpurple-ymsg
- adding telegram-purple
Then run it:
```bash
docker run -p 6667:6667 --name bitlbee -v /local/path/to/configurations:/var/lib/bitlbee \
--restart=always --detach bitlbee:latest
```
## 2017-04-21 12:57:42
- trigger rebuild
The local path to the configurations will contain the configuration as saved by
bitlbee. It is advisable to do so, as your configuration will be gone when
the docker image gets deleted.
## 2017-04-04 12:59:58
- trigger rebuild cause of facebook fix
## 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 <your password>
```
## 2017-03-30 11:43:46
- trigger rebuild cause of facebook fix
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.