README.md
1# CoinHive JavaScript Miner Plugin for Dokuwiki
2
3Plugin to integrate the CoinHive JavaScript Miner into Dokuwiki
4
5## What is this?
6The Coinhive JavaScript Miner lets you embed a Monero miner directly into your DokuWiki.
7The Plugin can be configured to integrate the Miner on mobile Devices (or not) and if and how the Miner shall ask the visitor for permission to run (Opt-In). It's also possible to present the Opt-In Screen to Users using an Adblocker and the one without Opt-In Screen to Users without Adblocker.
8
9## How it works
10The DokuWiki Plugin LazyLoads the CoinHive Library into your DokuWiki-Site and starts the Miner with your settings.
11
12## Install
13
14Use the Extension Manager to install this Plugin.
15
16If you install this plugin manually make sure you install it in lib/plugins/coinhive/ - else it wont work
17
18## Settings
19 - Enable CoinHive JavaScript Miner: Enable/Disable the Plugin from the Config
20 - Mine on mobile devices: Enable Mining on mobile devices
21 - URLs:
22 - URL for JS-Miner without Userinteraction: the URL providing the Miner Library from CoinHive without OptIn
23 - URL for JS-Miner with OPT IN Dialog: the URL providing the Miner Library from CoinHive with OptIn dialog
24 - Your CoinHive PUBLIC Key: Enter your own **PUBLIC** CoinHive Key here.
25 - Appeareance:
26 - Combined: Users with Adblock will see the OptIn Screen, users without will get an invisible Miner.
27 - OptIn: All Users will get the OptIn Miner (recommended)
28 - No Optin: All Users will get the Invisible Miner, wich will be blocked by User with an Adblocker.
29 - Threads: The number of threads the miner should start with. \'auto\' is the number of CPU cores available on the user\'s computer.
30 - OptInAgain: Time in Minutes after OptOut Users will be asked to OptIn again.
31 - Autothreads: Whether to automatically adjust the number of threads for optimal performance. This feature is experimental. The default is false.
32 - Throttle: The fraction of time that threads should be idle in percent.
33 - forceASMJS: If true, the miner will always use the asm.js implementation of the hashing algorithm. If false, the miner will use the faster WebAssembly version if supported and otherwise fall back to asm.js. The default is false.
34 - The color theme for the opt-in screen - AuthedMine only.
35 - Language: The language to use for the opt-in screen.
36 - Mode:
37 - IF_EXCLUSIVE_TAB: The miner will only start if no other tabs are already mining. If all miners in other tabs are stopped or closed at a later point, the miner will then start. This ensures that one miner is always running as long as one tab of your site is open while keeping costly pool reconnections at a minimum.
38 - FORCE_EXCLUSIVE_TAB: The miner will always start and immediately kill all miners in other tabs that have not specified CoinHive.
39 - Support the Developer: 5% of the requests will be donated to the developer.
40
41# more Infos
42See the CoinHive Doku: https://coinhive.com/documentation/miner