Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
76 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,33 @@ | ||
| # Remark42 [](https://github.com/umputun/remark42/actions) [](https://hub.docker.com/r/umputun/remark42) [](https://goreportcard.com/report/github.com/umputun/remark42) [](https://coveralls.io/github/umputun/remark42?branch=master) [](https://app.codecov.io/gh/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. | ||
|
|
||
| * Social login via Google, Twitter, Facebook, Microsoft, GitHub, Yandex, Patreon and Telegram | ||
| * Login via email | ||
| * Optional anonymous access | ||
| * Multi-level nested comments with both tree and plain presentations | ||
| * Import from Disqus and WordPress | ||
| * Markdown support with friendly formatter toolbar | ||
| * Moderator can remove comments and block users | ||
| * Voting, pinning and verification system | ||
| * Sortable comments | ||
| * Images upload with drag-and-drop | ||
| * Extractor for recent comments, cross-post | ||
| * RSS for all comments and each post | ||
| * Telegram, Slack, Webhook and email notifications for Admins (get notified for each new comment) | ||
| * Email and Telegram notifications for users (get notified when someone responds to your comment) | ||
| * Export data to JSON with automatic backups | ||
| * No external databases, everything embedded in a single data file | ||
| * Fully dockerized and can be deployed in a single command | ||
| * Self-contained executable can be deployed directly to Linux, Windows and macOS | ||
| * Clean, lightweight and customizable UI with white and dark themes | ||
| * Multi-site mode from a single instance | ||
| * Integration with automatic SSL (direct and via [nginx-le](https://github.com/nginx-le/nginx-le)) | ||
| * [Privacy focused](https://remark42.com/#privacy) | ||
|
|
||
| [Demo site](https://remark42.com/demo/) available with all authentication methods, including email auth and anonymous access. | ||
|
|
||
| <details><summary>Screenshots</summary> | ||
|
|
||
| Comments example: | ||
|  | ||
|
|
||
| For admin screenshots see [Admin UI documentation](https://remark42.com/docs/manuals/admin-interface/) | ||
| </details> | ||
|
|
||
| All remark42 documentation is available [by the link](https://remark42.com/docs/getting-started/installation/). | ||
|
|
||
| ## Related projects | ||
|
|
||
| * [A Helm chart for Remark42 on Kubernetes](https://github.com/groundhog2k/helm-charts/tree/master/charts/remark42) | ||
| * [django-remark42](https://github.com/andrewp-as-is/django-remark42.py) | ||
| # 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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Remark42 [](https://github.com/umputun/remark42/actions) [](https://hub.docker.com/r/umputun/remark42) [](https://goreportcard.com/report/github.com/umputun/remark42) [](https://coveralls.io/github/umputun/remark42?branch=master) [](https://app.codecov.io/gh/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. | ||
|
|
||
| * Social login via Google, Twitter, Facebook, Microsoft, GitHub, Yandex, Patreon and Telegram | ||
| * Login via email | ||
| * Optional anonymous access | ||
| * Multi-level nested comments with both tree and plain presentations | ||
| * Import from Disqus and WordPress | ||
| * Markdown support with friendly formatter toolbar | ||
| * Moderator can remove comments and block users | ||
| * Voting, pinning and verification system | ||
| * Sortable comments | ||
| * Images upload with drag-and-drop | ||
| * Extractor for recent comments, cross-post | ||
| * RSS for all comments and each post | ||
| * Telegram, Slack, Webhook and email notifications for Admins (get notified for each new comment) | ||
| * Email and Telegram notifications for users (get notified when someone responds to your comment) | ||
| * Export data to JSON with automatic backups | ||
| * No external databases, everything embedded in a single data file | ||
| * Fully dockerized and can be deployed in a single command | ||
| * Self-contained executable can be deployed directly to Linux, Windows and macOS | ||
| * Clean, lightweight and customizable UI with white and dark themes | ||
| * Multi-site mode from a single instance | ||
| * Integration with automatic SSL (direct and via [nginx-le](https://github.com/nginx-le/nginx-le)) | ||
| * [Privacy focused](https://remark42.com/#privacy) | ||
|
|
||
| [Demo site](https://remark42.com/demo/) available with all authentication methods, including email auth and anonymous access. | ||
|
|
||
| <details><summary>Screenshots</summary> | ||
|
|
||
| Comments example: | ||
|  | ||
|
|
||
| For admin screenshots see [Admin UI documentation](https://remark42.com/docs/manuals/admin-interface/) | ||
| </details> | ||
|
|
||
| All remark42 documentation is available [by the link](https://remark42.com/docs/getting-started/installation/). | ||
|
|
||
| ## Related projects | ||
|
|
||
| * [A Helm chart for Remark42 on Kubernetes](https://github.com/groundhog2k/helm-charts/tree/master/charts/remark42) | ||
| * [django-remark42](https://github.com/andrewp-as-is/django-remark42.py) |