https://github.com/ikarpovich/bitrix-push-server
Dockerized Bitrix Push Server
https://github.com/ikarpovich/bitrix-push-server
Last synced: about 1 month ago
JSON representation
Dockerized Bitrix Push Server
- Host: GitHub
- URL: https://github.com/ikarpovich/bitrix-push-server
- Owner: ikarpovich
- License: mit
- Created: 2018-09-25T09:02:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-26T12:14:34.000Z (over 6 years ago)
- Last Synced: 2024-12-06T21:27:18.588Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 4.88 KB
- Stars: 19
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bitrix - Dockerized Push Server
README
# What is Bitrix Push Server
Push Server is a NodeJS app built by [Bitrix Inc.](https://www.bitrix24.com) to handle realtime communications within Bitrix
platform. It is usually installed as part of [Bitrix Environment](https://www.bitrix24.com/self-hosted/installation.php).
# Use case for this Docker image
If you'd like to run Bitrix24 in Docker on your own making realtime comms, i.e. chat and video calls to work is tricky.
This image contains Bitrix Push Server from original Bitrix Environment package and can easily be placed into your existing project.
The image is tested to work with *Docker Compose* and *Docker Swarm*.
# How to use the image
## ... on its own
You have to start [Redis](https://hub.docker.com/_/redis/) first.
```console
$ docker run --name bitrix-push-server --link redis:redis -d ikarpovich/bitrix-push-server
```
## ... in [`Docker Swarm`](https://docs.docker.com/engine/reference/commandline/stack_deploy/) or via [`Docker Compose`](https://github.com/docker/compose)
The example below shows traefik installed in front of the cluster
```yaml
version: '3'
services:
push-server-sub:
image: ikarpovich/bitrix-push-server
links:
- redis
networks:
- default
- traefik-net
environment:
- REDIS_HOST=redis
- LISTEN_HOSTNAME=0.0.0.0
- LISTEN_PORT=80
- SECURITY_KEY=testtesttest
- MODE=sub
labels:
- traefik.port=80
- traefik.protocol=http
- traefik.frontend.rule=Host:bitrix24-sub.test
- traefik.docker.network=traefik-net
push-server-pub:
image: ikarpovich/bitrix-push-server
links:
- redis
networks:
- default
environment:
- REDIS_HOST=redis
- LISTEN_HOSTNAME=0.0.0.0
- LISTEN_PORT=80
- SECURITY_KEY=testtesttest
- MODE=pub
redis:
image: redis
networks:
- default
```
## Setup your Bitrix to support the server:
Message sender path: `http://push-server-pub/bitrix/pub/`
Signature code for server interaction: `testtesttest` (your `SECURITY_KEY`)
Message listener path: `http://bitrix24-sub.test/bitrix/subws/` (https:// ws:// wss://)
# Environment variables
### `LISTEN_HOSTNAME`
Hostname to bind daemon to, `0.0.0.0` by default
### `LISTEN_PORT`
Port to bind daemon to, `80` by default
### `REDIS_HOST`
Redis hostname, `redis` by default
### `REDIS_PORT`
Redis port, `6379` by default
### `SECURITY_KEY`
Security key, has to match one in *Push & Pull* system module settings
### `MODE`
Mode should be either `pub` or `sub`. You have to launch two containers with each mode to work.
# License
License for this image is MIT.
Bitrix and Bitrix Environment, Bitri Push Server are products licensed by Bitrix Inc. under their license terms.