hexo-leancloud-counter-security

[![npm-image]][npm-url]
[![node-image]][node-url]
[![hexo-image]][hexo-url]
[![travis-image]][travis-url]
[![lic-image]](LICENSE)

A plugin to fix a serious security bug in leancloud visitor counter for NexT theme site and other site that integrated this function using a similar way.

Documentation how to set the counter up and running safely aviable in English or Chinese languages.

And you can also read full explanation of current problem here.

Installation

![size-image]
[![dm-image]][npm-url]
[![dt-image]][npm-url]

``bash
npm install hexo-leancloud-counter-security
`

Usage

Activate this plugin in hexo's _config.yml (which locates in the root dir of your blog) by filling those options:
`yml
leancloud_counter_security:
enable_sync: true
app_id: <>
app_key: <>
server_url: <> # For CN region, optional
username: <> # Will be asked while deploying if is left blank
password: <> # Recommmended to be left blank. Will be asked while deploying if is left blank
`
If leancloud_counter_security not specified (or commented), plugin will totally disabled.

$3

This plugin integrated in «NexT» and after plugin enabled in main Hexo config, need to enable options in NexT config:
`yml
leancloud_visitors:
enable: true
app_id: <>
app_key: <>
# Dependencies: https://github.com/theme-next/hexo-leancloud-counter-security
security: true
betterPerformance: false
`

Explaination for betterPerformance:
Because the Leancloud developer's plan has limits in requst thread amount and running time, counter number may be very slow to load in some times. If set betterPerformance to true, counter number will be displayed quickly by assuming the request is accepted normally.

You should build the Leancloud background first to make the counter active.

After that, install this plugin and config it to make the counter safe.

$3

`
hexo lc-counter register <> <>
`
or
`
hexo lc-counter r <> <>
`
Register a user in your Leancloud database for authority control.

TroubleShooting

$3

For purpose of avoiding the 429 error code (Too Many Request) from leancloud, this plugin use a local database to store the records which have been successfully synchronized to the leancloud. Only the records that are not in the local database will be synchronized. This feature reduces the request quantity to avoid 429 error. The local databases is a json file named leancloud.memo in <>/source. Delete the leancloud.memo will not cause other flaws.

If you failed to sync records to the leancloud and you are sure about the plugin causes the fault. You can delete the leancloud.memo and deploy again. The command is following.

`
rm <>/source/leancloud.memo
hexo d
``

[npm-image]: https://img.shields.io/npm/v/hexo-leancloud-counter-security?style=flat-square
[node-image]: https://img.shields.io/node/v/hexo-leancloud-counter-security?style=flat-square
[hexo-image]: https://img.shields.io/badge/hexo-%3E%3D%203.0-blue?style=flat-square
[travis-image]: https://img.shields.io/travis/theme-next/hexo-leancloud-counter-security/master?style=flat-square
[lic-image]: https://img.shields.io/npm/l/hexo-leancloud-counter-security?style=flat-square

[size-image]: https://img.shields.io/github/languages/code-size/theme-next/hexo-leancloud-counter-security?style=flat-square
[dm-image]: https://img.shields.io/npm/dm/hexo-leancloud-counter-security?style=flat-square
[dt-image]: https://img.shields.io/npm/dt/hexo-leancloud-counter-security?style=flat-square

[npm-url]: https://www.npmjs.com/package/hexo-leancloud-counter-security
[node-url]: https://nodejs.org/en/download/releases
[hexo-url]: https://hexo.io
[travis-url]: https://travis-ci.org/theme-next/hexo-leancloud-counter-security?branch=master