aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md83
1 files changed, 21 insertions, 62 deletions
diff --git a/README.md b/README.md
index 9e5fb73..de8f20b 100644
--- a/README.md
+++ b/README.md
@@ -1,72 +1,31 @@
# docker-bitlbee-libpurple
-This docker image includes bitlbee with a bunch of useful plugins:
- - [facebook](https://github.com/jgeboski/bitlbee-facebook)
- - [steam](https://github.com/jgeboski/bitlbee-steam)
- - [skypeweb](https://github.com/EionRobb/skype4pidgin)
- - [telegram](https://github.com/majn/telegram-purple)
- - [hangouts](https://bitbucket.org/EionRobb/purple-hangouts)
- - [slack](https://github.com/dylex/slack-libpurple)
- - [sipe](https://github.com/tieto/sipe)
- - [discord](https://github.com/sm00th/bitlbee-discord)
- - [rocket.chat](https://bitbucket.org/EionRobb/purple-rocketchat)
- - [mastodon](https://github.com/kensanata/bitlbee-mastodon)
- - [matrix](https://github.com/matrix-org/purple-matrix)
- - [signal](https://github.com/hoehermann/libpurple-signald)
- - [icyque](https://github.com/EionRobb/icyque)
- - [whatsapp](https://github.com/hoehermann/purple-gowhatsapp) (only in debian based images)
+This repo is a [fork](https://github.com/ezkrg/docker-bitlbee-libpurple)
-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.
+**__NOTE__**: the alpine image unmaintained.
-## Building and running the image
-Build the image and tag it:
-```bash
-docker build -t bitlbee:latest .
-```
+This docker image includes bitlbee-libpurple with a bunch of useful plugins:
-Then run it:
-```bash
-docker run -p 6667:6667 --name bitlbee -v /local/path/to/configurations:/var/lib/bitlbee \
- --restart=always --detach bitlbee:latest
-```
+- [facebook](https://github.com/jgeboski/bitlbee-facebook)
+- [steam](https://github.com/jgeboski/bitlbee-steam)
+- telegram via [tdlib-purple](https://github.com/BenWiederhake/tdlib-purple/)
+- hangouts via [purple-hangouts](https://bitbucket.org/EionRobb/purple-hangouts)
+- slack via dylex's fork of [slack-libpurple](https://github.com/dylex/slack-libpurple)
+- [sipe](https://github.com/tieto/sipe)
+- discord via [purple-discord](https://github.com/EionRobb/purple-discord)
+- rocket.chat via [purple-rocketchat](https://bitbucket.org/EionRobb/purple-rocketchat)
+- [mastodon](https://github.com/kensanata/bitlbee-mastodon)
+- signal via [purple-presage](https://github.com/hoehermann/purple-presage)
+- icyque via [icyque](https://github.com/EionRobb/icyque)
+- whatsapp via [purple-gowhatsmeow](https://github.com/hoehermann/purple-gowhatsapp.git)
+- microsoft teams via [purple-teams](https://github.com/EionRobb/purple-teams)
-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.
+## Building and Running
-## 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>
-```
-
-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
+```bash
+docker build -t bitlbee-purple .
```
-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.
+```bash
+docker run -p 6667:6667 --name bitlbee -v /local/path/to/configurations:/var/lib/bitlbee --restart=always --detach bitlbee-purple
```
-
-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.
-