https://github.com/openfun/openedx-comments-docker
:whale: A handcrafted Docker image for the Open edX comment service
https://github.com/openfun/openedx-comments-docker
docker docker-image forum openedx
Last synced: about 1 year ago
JSON representation
:whale: A handcrafted Docker image for the Open edX comment service
- Host: GitHub
- URL: https://github.com/openfun/openedx-comments-docker
- Owner: openfun
- License: agpl-3.0
- Created: 2018-10-19T10:03:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-30T14:06:32.000Z (over 7 years ago)
- Last Synced: 2025-01-13T12:48:43.799Z (over 1 year ago)
- Topics: docker, docker-image, forum, openedx
- Language: Dockerfile
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open edX Comment Service Docker image
A handcrafted Docker image for the [Open edX comment
service](https://github.com/edx/cs_comments_service) (_aka_ forum).
## Installation
To add this image to your Open edX stack, pull our image from DockerHub (see
[fundocker/forum](https://hub.docker.com/r/fundocker/forum/)):
```bash
$ docker pull fundocker/forum
```
## Getting started
First things first, if you plan to work on the project itself, you will need to
clone this repository:
```
$ git clone git@github.com:openfun/openedx-comments-docker.git
```
Once the project has been cloned on your machine, you will need to build the
docker image for the forum and setup a development environment that includes all
required services up and running (more on this later):
```bash
$ cd openedx-comments-docker
$ make bootstrap
```
If everything went well, you should now be able to access the following
services:
- Forum: https://localhost:9292
- Open edX LMS: http://localhost:8000
- MailCatcher: http://localhost:1080
with the following credentials (for the LMS):
```
email: admin@foex.edu
password: openedx-rox
```
## Developer guide
Once the project has been bootstrapped (see "Getting started" section), to start
working on the project, use:
```
$ make dev
```
You can stop running services _via_:
```
$ make stop
```
If for any reason, you need to drop databases and start with fresh ones, use the
`down` target:
```
$ make down
```
## License
The code in this repository is licensed under the AGPL-3.0 unless otherwise
noted (see [LICENSE](./LICENSE) for details).