Merge pull request #260 from RocketChat/deprecate-compose

Deprecate local Docker Compose setup

Author: gabrielpetry

.github/workflows/build-test.yml

@@ -85,6 +85,7 @@ jobs:
         env:
           IMAGE: rocket.chat
           RELEASE: ${{ matrix.version }}
+          DEPRECATED_COMPOSE_ACK: "true"
         run: docker compose up -d
 
       - name: Wait for Rocket.Chat to start up

README.md

@@ -4,39 +4,11 @@ Rocket.Chat is a Web Chat Server, developed in JavaScript, using the Meteor full
 
 It is a great solution for communities and companies wanting to privately host their own chat service or for developers looking forward to build and evolve their own chat platforms.
 
-%%LOGO%%
+![Rocket.Chat Logo](./images/horizontal.png)
 
 # How to use this image
 ### Docker Compose
-If you need both the mongo and Rocket.Chat containers, use a docker compose one-liner:
 
-    docker compose up -d
+This docker compose is deprecated, for update please refer to https://docs.rocket.chat/docs/deploy-with-docker-docker-compose or https://github.com/RocketChat/rocketchat-compose
 
-Which will run both containers, with Rocket.Chat listening on http://localhost:3000
-Then, access it via `http://localhost:3000` in a browser.  Replace `localhost` in `ROOT_URL` with your own domain name if you are hosting at your own domain.
-
-Stop the containers with:
-
-    docker compose down
-
-### Individual containers
-First, start an instance of mongo:
-
-    docker run --name db -d mongo:4.0 mongod --smallfiles
-
-Then start Rocket.Chat linked to this mongo instance:
-
-    docker run --name rocketchat --link db:db -d rocket.chat
-
-This will start a Rocket.Chat instance listening on the default Meteor port of 3000 on the container.
-
-If you'd like to be able to access the instance directly at standard port on the host machine:
-
-    docker run --name rocketchat -p 80:3000 --env ROOT_URL=http://localhost --link db:db -d rocket.chat
-
-Then, access it via `http://localhost` in a browser.  Replace `localhost` in `ROOT_URL` with your own domain name if you are hosting at your own domain.
-
-If you're using a third party Mongo provider, or working with Kubernetes, you need to override the `MONGO_URL` environment variable:
-
-    docker run --name rocketchat -p 80:3000 --env ROOT_URL=http://localhost --env MONGO_URL=mongodb://mymongourl/mydb -d rocket.chat
 

compose.yml

@@ -11,6 +11,7 @@ services:
       traefik.http.routers.rocketchat.tls: "true"
       traefik.http.routers.rocketchat.entrypoints: https
       traefik.http.routers.rocketchat.tls.certresolver: le
+      DEPRECATED_COMPOSE: "${DEPRECATED_COMPOSE_ACK:?This compose file is deprecated, please migrate to https://github.com/RocketChat/rocketchat-compose}"
     environment:
       MONGO_URL: mongodb://mongodb:27017/rocketchat?replicaSet=rs0
       ROOT_URL: ${ROOT_URL:-http://localhost:3000}

images/horizontal.png

@@ -7,6 +7,8 @@ services:
   traefik:
     image: docker.io/traefik:${TRAEFIK_RELEASE:-v2.9.8}
     restart: always
+    labels:
+      DEPRECATED_COMPOSE: "${DEPRECATED_COMPOSE_ACK:?This compose file is deprecated, please migrate to https://github.com/RocketChat/rocketchat-compose}"
     command:
      - --api.insecure=false
      - --providers.docker=true