Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.3 KB

README.md

File metadata and controls

67 lines (45 loc) · 1.3 KB

Nchan Docker Image

A dockerized Nginx image configured with the Nchan module

Nchan Documentation at: Nchan.io

Usage

  • Create the required routes configured as publisher an subscribers. Refer to nchan-example.conf
server {
    listen       80;
    listen  [::]:80;
    server_name  localhost;

    location /publish {
        nchan_publisher;
        
        nchan_channel_id example;
        nchan_message_buffer_length 2000;
    }

    location /subscribe {
        nchan_subscriber;

        nchan_channel_id example;
        nchan_subscriber_timeout 30;
    }

}
  • Build the image copying the configuration file(s)

NOTICE: Please use a tagged version for stability, latest tags are prone to change and might affect your running applications

FROM safesecurity/nginx-nchan:latest

COPY nchan-example.conf /etc/nginx/conf.d/
  • Build the image

docker build -t my-nginx-image:latest .

  • Run the image using

docker run -d --name nginx -p 80:80 my-nginx-image:latest

  • Publishing a message
$ curl -d "hello=1" http://localhost/publish
queued messages: 1
last requested: -1 sec. ago
active subscribers: 0
last message id: 1627379093:0
  • Subscribing the message
$ curl http://localhost/subscribe  
hello=1