[{"_1":2,"_160":-5,"_161":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_139":140},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":21,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":-5,"_133":11,"_134":-5,"_135":136,"_137":91,"_138":-7},"canonicalUrl","https://hub.docker.com/r/quickbooks2018/docker-chat-websocket/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","quickbooks2018","reponame","docker-chat-websocket","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2022-05-01T00:48:41.048914Z","description","","is_private","last_updated","2022-05-01T00:48:41.133838Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",189,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Docker Web Socket Chat Application\n\n- https://hub.docker.com/r/ageapps/docker-chat/\n- https://github.com/ageapps/docker-chat\n- https://stackoverflow.com/questions/39336033/does-an-application-load-balancer-support-websockets\n- https://aws.amazon.com/blogs/aws/new-aws-application-load-balancer/\n\n- mongodb\n```mongodb\ndocker run -v \"$(pwd)\"/database:/data --name mongo_chat_db -id mongo:latest\n```\n\n- chatapp\n```chatapp\ndocker run -id --name node_chat_server -v \"$(pwd)\"/database:/data --link mongo_chat_db:db -p 8080:4000 quickbooks2018/docker-chat-websocket:latest\n```\n\n\n\n\n# docker-chat\n\nDockerized chat, based on my previous project [SocketIOChatDemo], which is an example of a web application using *socket.io* library.\n\nThis repository is a perfect example for a dockerized application having multiple services like a Database and a Backend. I personally use this project in demos for different technologies like [Kubernetes] or [Docker].\n\nThis project tries to follow a [Microservices architecture] where either in the [basic](#basic) setup nor the [advanced](#advanced) consist on multiple services that run in separate containers\n\n\n- [Features](#features)\n- [Demo](#demo)\n- [Basic Setup](#basic)\n - [Services](#b-services)\n - [Usage with git](#b-git)\n - [Usage with Docker Hub](#b-hub)\n- [Advanced Setup](#advanced)\n - [Services](#a-services)\n - [Deployment with docker-compose](#dep_docker)\n - [Deployment with Kubernetes](#dep_k8s)\n- [Resources](#resources)\n\n\n\n\n\n## Features\n\nIn order to provide a realistic demo this applications has the following features:\n\n+ __Database Perssistance:__ all messages and users are stored perssistently in a database.\n\n+ __Session Management:__ whenever te name is introduced, a session is created and managed using NodeJS module [Express Session]. Aditionally, in order to have persistent sessions while scalling our services, sessions are stored in the database using [MongoStore].\n+ __Websocket Support:__ being a chat application it's needed some kind of real time comunication between the clients and the server, for this [SocketIO] is used as [WebSocket] library. When scalling services using WebSockets there are 2 things to take care of;\n + `Session affinity`: in order to stablish the [WebSocket handshake] between the client and one of the replicas.\n + `Message replication`: once the hanndshake is stablished, messages need to be replicated through al replicas usinga queue that comunicates all of them.\n\nIMAGE WEBSOCKET\n\n+ __Storage Management:__ users can upload a profile photo, this implies handling file uploads and storage management. When scalling services, storage management becomes more complicated because all replicas need to access the same filesystem. This will be solved in 2 ways:\n + Local volume: when using `docker-compose` in a local enviroment this can be solved by creating a shared Docker `volume` between replicas.\n + Distributed filesystem: when deploying the application in a real-life enviroment, replicas will be distributed son sharing a local volume becomes impossible. For this, [Distributed Filesystems] are the best solution, in this example it will be used [GlusterFS].\n\nIMAGE STORAGE\n\n\n## Demo\n\nThis a basic demo of the chat working\n![demo](https://github.com/ageapps/docker-chat/blob/master/art/chat_demo.gif?raw=true)\n\n\n\n## Basic Setup\nThe basic setup adds to the [SocketIOChatDemo] a database where all mesages will be stored. Using this setup it is assumed that no service will be repplicated. The resulting system has the following modules and is described in the `docker-compose.yaml`.\n\n\n\n### Services\n\n![basic](./art/arch_1.png)\n+ __Web (app):__ [NodeJS] server containin all business logic and that [features](#features) mentioned above. It uses the official [NodeJS image] as base image.\n+ __Database (db):__ [MongoDB] database. It uses the official [MongoDB image] with an additional startup script which sets up users in order to have a securized database (using `MONGO_DB_APP_PASSWORD`, `MONGO_DB_APP_USERNAME`, `MONGO_DB_APP_DATABASE` enviroment variables).\n\n\n\n### Usage with git\n\n```bash\n$ git clone https://github.com/ageapps/docker-chat\n$ cd docker-chat\n$ docker-compose up\n# connect in your browser to :8080\n```\n\n\n### Usage with Docker Hub\n\n```bash\n# run mongo service\n$ docker run -v \"$(pwd)\"/database:/data --name mongo_chat_db -d mongo mongod --smallfiles\n# run docker-chat image\n$ docker run -d --name node_chat_server -v \"$(pwd)\"/database:/data --link mongo_chat_db:db -p 8080:4000 ageapps/docker-chat\n# connect in your browser to :8080\n```\n\n\n\n\n## Advanced Setup\nThe advanced setup tries to set up the appplication in a real deployment scenario. This deployment will be distributed and aims to reach a high availability system. All of this means that the architecture and setup will be more complex than the [basic](#basic) one. For advanced setup, the enviroment variable `SCALABLE` needs to be set to `true`.\n\nIn order to deploy a container based system into a distributed system there will be used 2 deployment options.\n\n+ [Using docker-compose](#dep_docker): any service can be scalled easilly and it is navively supported by Docker.\n+ [Using Kubernetes](#dep_k8s): K8s is currently one of the most used container orchestration tool. This is due to its versatility and high performance.\n\n\n\n### Services\n\n![advanced](./art/arch_2.png)\n+ __Web (app):__ [NodeJS] server containin all business logic and that [features](#features) mentioned above. It uses the official [NodeJS image] as base image.\n+ __Database (db):__ [MongoDB] database. It uses the official [MongoDB image] with an additional startup script which sets up users in order to have a securized database (using `MONGO_DB_APP_PASSWORD`, `MONGO_DB_APP_USERNAME`, `MONGO_DB_APP_DATABASE` enviroment variables).\n\n+ __Load Balancer (proxy):__ [traefik] proxy. __This service is only used when deploying with `docker-compose`__. This load balancer is needed in order to handle the service repplication and balance traffic between them aswell as session affinity for WebSocket support. It uses the official [traefik image] being the access point to the system. There is a management interface accesing `localhost` in port `8080`.\n![traefik](./art/traefik.png)\n\n+ __Message Broker (redis/rabbit/nats):__ This service is needed in order to scale WebSockets. The application supports 3 message brokers which are attached to [SocketIO] library as adapters:\n + `Redis`: It's possible to use the [Redis]'s publish/subscribe service as message broker. For this it's used the [Redis Adapter].\n To connect to the Redis service it's needed to use the `REDIS_HOST` enviroment variable.\n\n __NOTE:__ Redis has an extra limitation that all messages used by the publish/subscribe service have to be strings, for this the `PARSE_MSG` enviroment variable has to be added.\n\n + `RabbitMQ`: It's possible to use the [RabbitMQ] as message broker. For this it's used the [Rabbit Adapter].\n To connect to the RabbitMQ service it's needed to use the `RABBIT_HOST` enviroment variable.\n RabbitMQ has a management web interface which is accessible using `localhost` in port `15672`.\n ![rabbit](./art/rabbit.png)\n\n + `NATS`: It's possible to use the [NATS] as message broker. For this it's used the [NATS Adapter].\n To connect to the NATS service it's needed to use the `NATS_HOST` enviroment variable.\n There is a NATS dashboard which can be accessed using `localhost` in port `3000`.\n\n ![nats](./art/nats.png)\n\n\n\n### Deployment with docker-compose\nIn order to deploy the system with `docker-compose` it's needed an additional configuration. [traefik] proxy needs to use a DNS name in order to provide session affinity. For this, the DNS name chosen is `app.docker.localhost`, and it has to be added into the `/etc/hosts` file:\n\n```bash\n...\n127.0.0.1 app.docker.localhost\n...\n```\nDownload the source code:\n```bash\n$ git clone https://github.com/ageapps/docker-chat\n$ cd docker-chat\n```\nDeploy with any of the configurations proposed\n```bash\n# Redis configuration\n$ docker-compose -f docker-compose.redis.yaml up\n# Rabbit configuration\n$ docker-compose -f docker-compose.rabbit.yaml up\n# Nats configuration\n$ docker-compose -f docker-compose.nats.yaml up\n# connect in your browser to app.docker.localhost\n# connect in your browser to :8080 for the configuration pannel\n```\nScale the app service\n```bash\n# Redis configuration\n$ docker-compose -f docker-compose.redis.yaml scale app=5\n# Rabbit configuration\n$ docker-compose -f docker-compose.rabbit.yaml scale app=5\n# Nats configuration\n$ docker-compose -f docker-compose.nats.yaml scale app=5\n```\n\n\n### Deployment with Kubernetes\nOnce `kubectl` is set up and connected to your cluster, the following steps should be followed in order to deploy the application:\n\n#### Global configurations\nThere are global configurations needed for deployment, like database credentials.\n```bash\n$ kubectl apply -f k8s/global-config.yaml\n```\n#### Services\nThese include the rest of the services used in the system.\n\nBefore deploying any service it's needed to choose a message broker, once this is done, it's necessary to configure it in the `k8s/docker-chat/docker-chat.yaml` file by un commenting the configuration needed for each message broker.\n```yaml\n###### MESSAGE BROKERS ########\n # # REDIS\n # - name: REDIS_HOST\n # valueFrom:\n # configMapKeyRef:\n # name: global-config\n # key: app.redis_host\n # RABBIT\n - name: RABBIT_HOST\n valueFrom:\n configMapKeyRef:\n name: global-config\n key: app.rabbit_host\n # # NATS\n # - name: NATS_HOST\n # valueFrom:\n # configMapKeyRef:\n # name: global-config\n # key: app.nats_host\n```\n\n```bash\n$ kubectl apply -f k8s/mongo\n# Depending on chosen broker\n$ kubectl apply -f k8s/rabbit\n$ kubectl apply -f k8s/redis\n$ kubectl apply -f k8s/nats\n# Main service\n$ kubectl apply -f k8s/docker-chat\n```\n\n#### Ingress deployment\nAs mentioned in the services section, since WebSockets are used, it's needed to have session affinity in the `Load Balancer` service of our system, for this, it's proviced an example [here](./k8s/ingress) (`/k8s/ingress`) using [NGINX Ingress Controller]. You can find more information about the ingress controller and other examples of them in the [ingress documentation].\n\nAfter following these instructions, the ingress has to be configured.\n```bash\n$ kubectl apply -f k8s/ingress/app-ingress.yaml\n```\n#### GlusterFS deployment\nConsidering a [GlusterFS] cluster is already deployed ([Here](https://github.com/GoogleCloudPlatform/compute-ansible-gluster) is a great example of how to do it) let`s mount it as a volume in our containers.\nIn order to use the [GlusterFS] feature there are some considerations to take care. On the first hand, the cluster ip adresses should be added into the `glusterfs/glusterfs.yaml` file.\n```yaml\nkind: Endpoints\napiVersion: v1\nmetadata:\n name: glusterfs\nsubsets:\n - addresses:\n - ip: XXXXX\n ports:\n - port: 1\n - addresses:\n - ip: XXXXX\n ports:\n - port: 1\n```\nAdditionaly, the commented lines related to the volume mount of the GlusterFS system need to be uncommented:\n```yaml\nspec:\n # volumes:\n # - name: glusterfs-content\n # glusterfs:\n # endpoints: glusterfs-cluster\n # path: kube-vol\n # readOnly: true\n containers:\n - name: \"docker-chat\"\n image: \"ageapps/docker-chat:app\"\n imagePullPolicy: Always\n ports:\n - containerPort: 3000\n command: [\"bash\", \"-c\", \"nodemon ./bin/www\"]\n # volumeMounts:\n # - name: glusterfs-content\n # mountPath: /uploads\n```\nFinally, update all services and deploy the needed services. There is the possibillity to test what the content inside the cluster is by deloying the `browser` service.\n```bash\n$ kubectl apply -f k8s/glusterfs\n# Main service\n$ kubectl apply -f k8s/docker-chat\n# Browser service\n$ kubectl apply -f k8s/browser\n```\n\n\n## Resources\n+ [Docker]: Software containerization platform\n+ [SocketIOChatDemo]: Chat web application.\n+ [NodeJS]: Server enviroment.\n+ [MongoDB]: NoSQL database system.\n+ [mongoose]: MongoDB object modeling for *node.js*.\n+ [docker-build]: Automated build of *Docker* images.\n+ [docker-compose]: Automated configuration and run of multi-container *Docker* applications.\n+ [Kubernetes]: Open-source system for automating deployment, scaling, and management of containerized applications.\n\n\n[here]: http://swarm1397.cloudhero.io:8080/\n[Microservices architecture]: http://microservices.io/patterns/microservices.html\n[SocketIOChatDemo]: https://github.com/ageapps/SocketIOChatDemo.git\n[NodeJS image]: https://hub.docker.com/_/node/\n[MongoDB image]: https://hub.docker.com/_/mongo/\n[MongoDB]: https://www.mongodb.com\n[mongoose]: http://mongoosejs.com/index.html\n[NodeJS]: http://nodejs.org\n[Docker]: https://docs.docker.com/\n[docker-compose]:https://docs.docker.com/compose/compose-file/\n[docker-build]:https://docs.docker.com/engine/reference/builder/\n[Kubernetes]:https://kubernetes.io/\n[WebSocket handshake]:https://tools.ietf.org/html/rfc6455\n[WebSocket]:https://en.wikipedia.org/wiki/WebSocket\n[MongoStore]:https://www.npmjs.com/package/connect-mongo\n[GlusterFS]:https://www.gluster.org/\n[traefik]:https://traefik.io/\n[NATS]:https://nats.io/\n[NATS Adapter]:https://www.npmjs.com/package/socket.io-nats\n[RabbitMQ]:https://www.rabbitmq.com/\n[Rabbit Adapter]:https://www.npmjs.com/package/socket.io-amqp\n[Redis]:https://redis.io/\n[Redis Adapter]:https://github.com/socketio/socket.io-redis\n[traefik image]:https://hub.docker.com/r/_/traefik/\n[SocketIO]:https://socket.io/\n[Express Session]:https://github.com/expressjs/session\n[NGINX Ingress Controller]: https://github.com/kubernetes/ingress-nginx\n[ingress documentation]: https://github.com/kubernetes/ingress-nginx/blob/master/docs/catalog.md\n\n\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",271520712,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",2608499,"full_size",271512263,"id",205931701,"images",[101],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},"architecture","amd64","digest","sha256:4adc68cb91cae3eb2d0f1006f382cd99a2229a8531e2d09950337872b51b0ea0","features","last_pulled","2026-10-08T12:35:05.101367445Z","last_pushed","2016-10-29T19:04:30Z","os","linux","os_features","os_version","size","variant","2022-05-01T00:48:41.125159Z","last_updater","last_updater_username","media_type","latest","repository",17032282,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":141,"_148":149,"_135":158,"_159":11},{"_40":142,"_42":143,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":144,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":145,"_79":11,"_80":147,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":146},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_150":64,"_151":-5,"_152":-5,"_153":154},"count","next","previous","results",[155],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":156,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[157],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

quickbooks2018/docker-chat-websocket

Tags for quickbooks2018/docker-chat-websocket