README.md

# Remark42 for Coventry University

## About

_This repository contains a patched version of [Remark42](https://github.com/umputun/remark42)._

> Remark42 is a self-hosted, lightweight and simple (yet functional) comment engine, which doesn't spy on users. It can be embedded into blogs, articles, or any other place where readers add comments.

- [Original README.md][original-readme]
- [Remark42 Documentation][remark42-docs]

## Changes

The following changes were made to the upstream version:

* Change provider URLs, to enable OAuth authentication against [Coventry University's GitHub Enterprise server](https://github.coventry.ac.uk)

## How to Use

The easiest way to use this version of Remark42 is within a `docker-compose.yml` configuration. Ensure your service definition includes this repository as the build source as follows.

``` yaml
services:
  remark42:
    build: https://github.coventry.ac.uk/ab5169/remark42.git
```

See the [Remark42 documentation][remark42-docs] for details of [environment variables][remark42-parameters] and other configuration options.

[original-readme]: README.original.md
[remark42-docs]: https://remark42.com/docs/getting-started/installation/
[docker-compose]: https://docs.docker.com/compose/
[remark42-parameters]: https://remark42.com/docs/configuration/parameters/