{"id":14235901,"url":"https://github.com/mbologna/docker-bitlbee","last_synced_at":"2025-04-10T18:16:04.980Z","repository":{"id":34270823,"uuid":"38157424","full_name":"mbologna/docker-bitlbee","owner":"mbologna","description":"Run bitlbee with TLS and custom protocols in a container","archived":false,"fork":false,"pushed_at":"2023-12-24T15:41:44.000Z","size":44,"stargazers_count":42,"open_issues_count":1,"forks_count":24,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-13T12:57:36.123Z","etag":null,"topics":["bitlbee","discord","docker","dockerfile","facebook","hacktoberfest","hangouts","instagram","mastodon","matrix","mattermost","protocol","rocketchat","skype","slack","steam","telegram"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mbologna.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-06-27T11:17:33.000Z","updated_at":"2024-04-12T07:54:05.000Z","dependencies_parsed_at":"2024-01-07T09:43:23.254Z","dependency_job_id":null,"html_url":"https://github.com/mbologna/docker-bitlbee","commit_stats":{"total_commits":69,"total_committers":7,"mean_commits":9.857142857142858,"dds":"0.37681159420289856","last_synced_commit":"5778e78c78fd79d0527f4281950f0a1c68fc6fd7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbologna%2Fdocker-bitlbee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbologna%2Fdocker-bitlbee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbologna%2Fdocker-bitlbee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbologna%2Fdocker-bitlbee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbologna","download_url":"https://codeload.github.com/mbologna/docker-bitlbee/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415930,"owners_count":20935385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitlbee","discord","docker","dockerfile","facebook","hacktoberfest","hangouts","instagram","mastodon","matrix","mattermost","protocol","rocketchat","skype","slack","steam","telegram"],"created_at":"2024-08-20T21:02:29.410Z","updated_at":"2025-04-10T18:16:04.961Z","avatar_url":"https://github.com/mbologna.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# BitlBee with additional plugins in a container\n\n![Docker](https://img.shields.io/docker/pulls/mbologna/docker-bitlbee)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mbologna/docker-bitlbee/build-scan-push.yml?branch=master)\n\nThis repository provides a Docker-based setup for running [Bitlbee](https://www.bitlbee.org/) with additional plugins for extended functionality and an optional [Stunnel](https://www.stunnel.org/) service to enable secure IRC communications over TLS.\n\n## Features\n\n- **[Bitlbee](https://www.bitlbee.org)**: A popular gateway that connects instant messaging services with IRC. In addition to the [Bitlbee's out of the box supported protocols](https://wiki.bitlbee.org/), these are the pre-installed plugins:\n    - Google Hangouts via [purple-hangouts](https://github.com/EionRobb/purple-hangouts)\n    - Discord via [purple-discord](https://github.com/EionRobb/purple-discord)\n    - Matrix via [purple-matrix](https://github.com/matrix-org/purple-matrix)\n    - Microsoft Teams via [teams](https://github.com/EionRobb/purple-teams)\n    - Slack via [slack-libpurple](https://github.com/dylex/slack-libpurple)\n    - Skype via [skype4pidgin](https://github.com/EionRobb/skype4pidgin)\n    - Facebook (MQTT) via [bitlbee-facebook](https://github.com/bitlbee/bitlbee-facebook)\n    - Mastodon via [bitlbee-mastodon](https://alexschroeder.ch/software/Bitlbee_Mastodon)\n    - Telegram via [tdlib-purple](https://github.com/BenWiederhake/)\n- **[Stunnel](https://www.stunnel.org/)**: Adds TLS encryption for secure IRC connections.\n- Multi-architecture support: builds for `linux/amd64` and `linux/arm64`.\n- Kubernetes resources included for deployment in containerized environments.\n- Linting and security scans integrated into CI/CD workflows.\n\n## Quick Start\n\n### Running Locally with Podman or Docker Compose\n\n1. Clone this repository:\n   ```bash\n   git clone https://github.com/mbologna/docker-bitlbee.git\n   cd docker-bitlbee\n\n2. Build and run the containers:\n\n    ```\n    podman-compose up --build\n    ```\n\n    If you're using Docker:\n    ```\n    docker-compose up --build\n    ```\n\n3. Access the Bitlbee service on port 6667 and the Stunnel service on port 16697.\n\n#### Environment Variables\n\n`UID` and `GID`: Set these to match your local user for proper volume permissions.\n\n#### Persistent Data\n\nThe `data/` directory is mounted as a volume to store Bitlbee configurations and data. Ensure it is backed up for persistent setups.\n\n### Kubernetes Deployment\n\nKubernetes manifests for deploying Bitlbee and Stunnel are located in the `k8s/` directory.\n\n1. Apply the manifests:\n\n```\nkubectl apply -f k8s/\n```\n\nVerify deployment:\n```\nkubectl get pods -n bitlbee\n```\nExpose the service as needed (e.g., via `NodePort` or `Ingress`).\n\n## CI/CD Workflow\n\nThis repository uses GitHub Actions for automated builds and deployments:\n\n* Build and Push: Docker images are built for amd64 and arm64 platforms and pushed to:\n    - Docker Hub: `mbologna/docker-bitlbee:latest`\n    - GitHub Container Registry: `ghcr.io/mbologna/docker-bitlbee:latest`\n\n* Linting: Integrated linters for Dockerfile, shell scripts, and Kubernetes resources.\n* Security Scans: Uses Trivy to scan Docker images for vulnerabilities.\n\n## Local Development\n\n### Building Multi-Arch Images Locally\n\nFor multi-architecture builds with Podman:\n\n```\npodman build --platform linux/amd64,linux/arm64 -t mbologna/docker-bitlbee:latest .\n```\n\nOr with Docker:\n\n```\ndocker buildx build --platform linux/amd64,linux/arm64 -t mbologna/docker-bitlbee:latest --push .\n```\n\n## Resources\n\n[BitlBee Documentation](https://wiki.bitlbee.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbologna%2Fdocker-bitlbee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbologna%2Fdocker-bitlbee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbologna%2Fdocker-bitlbee/lists"}