From fb6af6ca13319443c8d3371ff51ea70347c29b8a Mon Sep 17 00:00:00 2001 From: Umputun Date: Tue, 19 Feb 2019 14:24:30 -0600 Subject: [PATCH] refactor readme about anon access --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9d08c92c..a6a3e098 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ 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, Facebook, Github and Yandex +* Optional anonymous access * Multi-level nested comments with both tree and plain presentations * Import from disqus and wordpress * Markdown support @@ -11,11 +12,12 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi * Sortable comments * Extractor for recent comments, cross-post * RSS for all comments and each post +* Telegram notifications * 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 fully customizable UI +* Clean, lightweight and customizable UI * Multi-site mode from a single instance * Integration with automatic ssl (direct and via [nginx-le](https://github.com/umputun/nginx-le)) * [Privacy focused](#privacy) @@ -230,6 +232,13 @@ _instructions for google oauth2 setup borrowed from [oauth2_proxy](https://githu For more details refer to [Yandex OAuth](https://tech.yandex.com/oauth/doc/dg/concepts/about-docpage/) and [Yandex.Passport](https://tech.yandex.com/passport/doc/dg/index-docpage/) API documentation. +##### Anonymous Auth Provider + +Optionally, anonymous access can be turned on. In this case an extra `anonymous` provider will allow logins without any social login with any name satisfying 2 conditions: + +- name should be at least 3 characters long +- name has to start from the letter and contains letters, numbers, underscores and spaces only. + #### Initial import from Disqus 1. Disqus provides an export of all comments on your site in a g-zipped file. This is found in your Moderation panel at Disqus Admin > Setup > Export. The export will be sent into a queue and then emailed to the address associated with your account once it's ready. Direct link to export will be something like `https://.disqus.com/admin/discussions/export/`. See [importing-exporting](https://help.disqus.com/customer/portal/articles/1104797-importing-exporting) for more details. @@ -476,11 +485,6 @@ type User struct { _currently supported providers are `google`, `facebook`, `github` and `yandex`_ -Optionally, anonymous access can be turned on. In this case and extra `anonymous` provider will allow logins without any social login with any name satisfying 2 conditions: - -- name should be at least 3 characters long -- name has to start from the letter and contains letters, numbers, underscores and spaces only. - ### Commenting * `POST /api/v1/comment` - add a comment. _auth required_