|
1 | | -# Official Image Here |
| 1 | +# Official Rocket.Chat image |
| 2 | + |
| 3 | +## Supported tags and respective `Dockerfile` links |
| 4 | + |
| 5 | +- [`0.4.0`, `latest` (*Dockerfile*)](https://github.com/RocketChat/Docker.Official.Image/blob/master/Dockerfile) |
| 6 | + |
| 7 | +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). |
| 8 | + |
| 9 | +## Rocket.Chat |
| 10 | + |
| 11 | +Rocket.Chat is a Web Chat Server, developed in JavaScript, using the Meteor fullstack framework. |
| 12 | + |
| 13 | +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. |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +## How to use this image |
| 18 | + |
| 19 | +First, start an instance of mongo: |
| 20 | + |
| 21 | + docker run --name db -d mongo mongod --smallfiles |
| 22 | + |
| 23 | +Then start Rocket.Chat linked to this mongo instance: |
| 24 | + |
| 25 | + docker run --name rocketchat --env ROOT_URL=http://localhost --link db Rocket.Chat |
| 26 | + |
| 27 | +This will start a Ghost instance listening on the default Ghost port of 3000. |
| 28 | + |
| 29 | +If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used: |
| 30 | + |
| 31 | + docker run --name rocketchat -p 80:3000 --env ROOT_URL=http://localhost --link db:db -d Rocket.Chat |
| 32 | + |
| 33 | +Then, access it via `http://localhost:80` or `http://host-ip:80` in a browser. |
| 34 | + |
| 35 | +## User Feedback |
| 36 | + |
| 37 | +### Documentation |
| 38 | + |
| 39 | +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. |
| 40 | + |
| 41 | +### Issues |
| 42 | + |
| 43 | +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). |
| 44 | + |
| 45 | +You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net). |
| 46 | + |
| 47 | +### Contributing |
| 48 | + |
| 49 | +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. |
| 50 | + |
| 51 | +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. |
2 | 52 |
|
0 commit comments