Feat: add TLS termination via bitlbee

Fixes #6

README.md

@@ -1,39 +1,62 @@
 ## Features
 
-In addition to the [Bitlbee's out of the box supported protocols](https://wiki.bitlbee.org/), this container also supports the following protocols:
+* In addition to the [Bitlbee's out of the box supported protocols](https://wiki.bitlbee.org/), this container also supports the following protocols:
 
-- Skype via [skype4pidgin](https://github.com/EionRobb/skype4pidgin)
+    - Skype via [skype4pidgin](https://github.com/EionRobb/skype4pidgin)
-- Telegram via [telegram-purple](https://github.com/majn/telegram-purple)
+    - Telegram via [telegram-purple](https://github.com/majn/telegram-purple)
-- Facebook (MQTT) via [bitlbee-facebook](https://github.com/bitlbee/bitlbee-facebook)
+    - Facebook (MQTT) via [bitlbee-facebook](https://github.com/bitlbee/bitlbee-facebook)
-- Google Hangouts via [purple-hangouts](https://bitbucket.org/EionRobb/purple-hangouts)
+    - Google Hangouts via [purple-hangouts](https://bitbucket.org/EionRobb/purple-hangouts)
-- Mastodon via [bitlbee-mastodon](https://alexschroeder.ch/software/Bitlbee_Mastodon)
+    - Mastodon via [bitlbee-mastodon](https://alexschroeder.ch/software/Bitlbee_Mastodon)
-- Rocket.Chat via [purple-rocketchat](https://bitbucket.org/EionRobb/purple-rocketchat/src/default/)
+    - Rocket.Chat via [purple-rocketchat](https://bitbucket.org/EionRobb/purple-rocketchat/src/default/)
-- Discord via [bitlbee-discord](https://github.com/sm00th/bitlbee-discord/)
+    - Discord via [bitlbee-discord](https://github.com/sm00th/bitlbee-discord/)
-- Slack via [slack-libpurple](https://github.com/dylex/slack-libpurple)
+    - Slack via [slack-libpurple](https://github.com/dylex/slack-libpurple)
-- Steam via [bitlbee-steam](https://github.com/bitlbee/bitlbee-steam)
+    - Steam via [bitlbee-steam](https://github.com/bitlbee/bitlbee-steam)
-- Matrix via [purple-matrix](https://github.com/matrix-org/purple-matrix)
+    - Matrix via [purple-matrix](https://github.com/matrix-org/purple-matrix)
-- Mattermost via [puple-mattermost](https://github.com/EionRobb/purple-mattermost)
+    - Mattermost via [puple-mattermost](https://github.com/EionRobb/purple-mattermost)
-- Instagram via [purple-instagram](https://github.com/EionRobb/purple-instagram)
+    - Instagram via [purple-instagram](https://github.com/EionRobb/purple-instagram)
+
+* The `docker-compose.yml` provided in this repository enables bitlbee to be TLS terminated via [stunnel](https://www.stunnel.org/).
 
 ## Usage
 
 1. Clone the project:
 
-       git clone https://www.github.com/mbologna/docker-bitlbee
+       % git clone https://www.github.com/mbologna/docker-bitlbee
 
 2. (Optional) Customize bitlbee configuration file in `etc/bitlbee/bitlbee.conf`
 
-3. Run bitlbee via:
+3. Start `bitlbee` either via:
 
-    a. [Docker Compose](https://docs.docker.com/compose/install/):
+    * [Docker Compose](https://docs.docker.com/compose/install/) (recommended):
 
-        docker-compose up
+        ```
+        % docker-compose up
+        ```
 
-    b. or via Docker:
+    * Docker:
 
-        docker volume create bitlbee_data
+        ```
-        docker run -d --name bitlbee -p 16667:6667 --restart=always -v $PWD/etc/bitlbee:/usr/local/etc/bitlbee mbologna/docker-bitlbee
+        % docker volume create bitlbee_data
+        % docker run -d --name bitlbee \
+                        --restart=always \
+                        -p 16667:6667 \
+                        -v $PWD/etc/bitlbee:/usr/local/etc/bitlbee \
+                        mbologna/docker-bitlbee
+        % docker run -d --name bitlbee-stunnel \
+                        --restart=always \
+                        --link bitlbee:bitlbee
+                        -e STUNNEL_SERVICE=bitlbee-stunnel \
+                        -e STUNNEL_ACCEPT=6697 \
+                        -e STUNNEL_CONNECT=bitlbee:6667 \
+                        -p 16697:6697 \
+                        dweomer/stunnel
+        ```
+
+4. Connect your IRC client either to:
+
+    * localhost:16697 (TLS terminated) (recommended)
+    * localhost:16667 (non-TLS, plain connection)
 
 ## Building
 
-You can build a bitlbee image from Dockerfile: `docker build -t="mbologna/docker-bitlbee" github.com/mbologna/docker-bitlbee`
+You can build a `bitlbee` image from Dockerfile: `docker build -t="mbologna/docker-bitlbee" github.com/mbologna/docker-bitlbee`

docker-compose.yml

@@ -1,17 +1,35 @@
 version: "2.0"
 
 services:
-  app:
+  bitlbee:
     build: .
     image: mbologna/docker-bitlbee
     container_name: bitlbee
     restart: always
     ports:
       - "16667:6667"
-    network_mode: bridge
+    networks:
+      - bitlbee
     volumes:
       - ./etc/bitlbee:/usr/local/etc/bitlbee
       - bitlbee_data:/var/lib/bitlbee
+  stunnel:
+    image: dweomer/stunnel
+    container_name: bitlbee-stunnel
+    restart: always
+    networks:
+      - bitlbee
+    ports:
+      - "16697:6697"
+    environment:
+      - STUNNEL_SERVICE=bitlbee-stunnel
+      - STUNNEL_ACCEPT=6697
+      - STUNNEL_CONNECT=bitlbee:6667
+    depends_on:
+      - bitlbee
 
 volumes:
   bitlbee_data:
+
+networks:
+  bitlbee: