diff --git a/rocket.chat/README.md b/rocket.chat/README.md new file mode 100644 index 000000000..efaa238bc --- /dev/null +++ b/rocket.chat/README.md @@ -0,0 +1,63 @@ +# Supported tags and respective `Dockerfile` links + +- [`0.4.0`, `0.4`, `0`, `latest` (*Dockerfile*)](https://github.com/RocketChat/Docker.Official.Image/blob/607714350ff360aa5e0e493fd2cb6057684a980b/Dockerfile) + +For more information about this image and its history, please see the [relevant manifest file (`library/rocket.chat`)](https://github.com/docker-library/official-images/blob/master/library/rocket.chat) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images). + +# Rocket.Chat + +Rocket.Chat is a Web Chat Server, developed in JavaScript, using the Meteor fullstack framework. + +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](https://rawgit.com/docker-library/docs/master/rocket.chat/logo.svg) + +# How to use this image + +First, start an instance of mongo: + + docker run --name db -d mongo --smallfiles + +Then start Rocket.Chat linked to this mongo instance: + + docker run --name rocketchat --link 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 -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 + +# License + +View [license information](https://github.com/RocketChat/Rocket.Chat/blob/master/LICENSE) for the software contained in this image. + +# Supported Docker versions + +This image is officially supported on Docker version 1.8.1. + +Support for older versions (down to 1.0) is provided on a best-effort basis. + +# User Feedback + +## Documentation + +Documentation for this image is stored in the [`rocket.chat/` directory](https://github.com/docker-library/docs/tree/master/rocket.chat) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request. + +## Issues + +If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/RocketChat/Docker.Official.Image/issues). + +You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net). + +## Contributing + +You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can. + +Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/RocketChat/Docker.Official.Image/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.