Browse Source

docs(module/toxic-swamp): remove old demo and simplify installation

Josh Habdas 11 months ago
parent
commit
6e19c9bd9a
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74

+ 5
- 3
docs/content/feature/release-hashes.md View File

@@ -29,10 +29,12 @@ Run the [Release Validator](/validate) to quickly check your release offline:
29 29
 <iframe title="Validate Release" scrolling="no" width="100%" height="360" src="/validate"></iframe>
30 30
 {{< /hackcss-card >}}
31 31
 
32
-For a more thorough inspection do the following, comparing your hash with those generated during the release as defined above:
32
+For a more thorough inspection do the following:
33 33
 
34 34
 1. Install the {{< external href="https://docs.npmjs.com/cli/npm" text="npm cli" />}} on your machine.
35 35
 2. Navigate to `themes/after-dark` from within your site.
36
-3. Run `npm run integrity` to generate your SHA-512 hash.
36
+3. Run `npm i && npm run integrity` to generate your SHA-512 hash.
37
+4. Compare your hash to the hash generated during a signed release.
38
+5. If equal, verify the GPG signature used to sign that release.
37 39
 
38
-If everything matches you're all set. If not, please {{< external href="https://git.habd.as/comfusion/after-dark/issues/new" text="Submit an Issue" />}}.
40
+If inspection fails run the [Upgrade Script](../upgrade-script/) and try again.

+ 34
- 73
docs/content/module/toxic-swamp.md View File

@@ -8,67 +8,21 @@ tags = ["module", "monetization", "rewards", "cryptocurrency"]
8 8
 features = ["snippets", "related content"]
9 9
 +++
10 10
 
11
-<a id="footnote-return"></a>
12
-Monetize attention in one of more than 40 cryptocurrency mining pools and take home over 200% more per hash when compared to Coinhive.[^1]
13
-
14
-<section>
15
-  <style>.form { width: unset }</style>
16
-  {{< hackcss-grid >}}
17
-    {{< hackcss-cell class="-4of12" >}}
18
-      {{< hackcss-card header="Step 1" >}}
19
-        {{< hackcss-form action="https://git.habd.as/comfusion/toxic-swamp/releases" >}}
20
-          {{< hackcss-button type="primary" isblock="true" isghost="true" >}}
21
-            <svg class="i-download" viewBox="0 0 32 32" width="24" height="24" fill="none" stroke="currentcolor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2">
22
-              <path d="M9 22 C0 23 1 12 9 13 6 2 23 2 22 10 32 7 32 23 23 22 M11 26 L16 30 21 26 M16 16 L16 30"></path>
23
-            </svg>&nbsp;&nbsp;Download
24
-          {{< /hackcss-button >}}
25
-        {{< /hackcss-form >}}
26
-      {{< /hackcss-card >}}
27
-    {{< /hackcss-cell >}}
28
-    {{< hackcss-cell class="-4of12" >}}
29
-      {{< hackcss-card header="Step 2" >}}
30
-        {{< hackcss-form action="#installation" >}}
31
-          {{< hackcss-button type="info" isblock="true" isghost="true" >}}
32
-            <svg id="source" aria-labelledby="source-label" class="i-code" viewBox="0 0 32 32" width="24" height="24" fill="none" stroke="currentcolor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2">
33
-              <path d="M10 9 L3 17 10 25 M22 9 L29 17 22 25 M18 7 L14 27" />
34
-            </svg>&nbsp;&nbsp;Install
35
-          {{< /hackcss-button >}}
36
-        {{< /hackcss-form >}}
37
-      {{< /hackcss-card >}}
38
-    {{< /hackcss-cell >}}
39
-    {{< hackcss-cell class="-4of12" >}}
40
-      {{< hackcss-card header="Step 3" >}}
41
-        {{< hackcss-form action="#receiving-rewards" >}}
42
-          {{< hackcss-button type="success" isblock="true" isghost="true" >}}
43
-            <svg id="i-creditcard" viewBox="0 0 32 32" width="24" height="24" fill="none" stroke="currentcolor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2">
44
-              <path d="M2 7 L2 25 30 25 30 7 Z M5 18 L9 18 M5 21 L11 21" />
45
-              <path d="M2 11 L2 13 30 13 30 11 Z" fill="currentColor" />
46
-            </svg>&nbsp;&nbsp;Profit
47
-          {{< /hackcss-button >}}
48
-        {{< /hackcss-form >}}
49
-      {{< /hackcss-card >}}
50
-    {{< /hackcss-cell >}}
51
-  {{< /hackcss-grid >}}
52
-</section>
53
-
54
-Basic set-up is simple. October 2018 hard fork supported. Works with both Cryptonight and Cryptonight-Light. {{< external text="Kovri I2P Router" href="https://getkovri.org" />}} integration anticipated.
55
-
56
-## Demo
11
+Monetize attention in one of more than 40 cryptocurrency mining pools and take home 200% more per hash when compared to Coinhive.[^1]
57 12
 
58 13
 {{< hackcss-alert >}}
59
-  <video controls preload="auto" width="100%">
60
-    <source src="https://jhabdas.keybase.pub/toxic-swamp-demo.mp4" type="video/mp4">
61
-    <p>Your browser doesn't support HTML5 video. Here is a <a href="https://jhabdas.keybase.pub/after-dark-web-mining-prototype.mp4">link to the video</a> instead.</p>
62
-  </video>
14
+<img width="746" height="466" alt="Toxic Swamp screenshot" src="/images/screenshots/after-dark-v6.15.0-homepage-fs8.png">
63 15
 {{< /hackcss-alert >}}
64 16
 
65 17
 ## Features
66 18
 
67 19
 - Transparent, unobtrusive multilingual user interface
68 20
 - Does not use cookies or connect to any third-parties
21
+- Obfuscates end-user IPs and other connection details
69 22
 - Automatically starts when external power is detected
70 23
 - Suspends operation during loss of power or attention
71
-- Functions like an application without the complexity
24
+- Optimized for low-bandwidth high-latency connections
25
+- Ideal for IoT and distributed computing environments
72 26
 
73 27
 ## Installation
74 28
 
@@ -87,11 +41,12 @@ Extract module contents into site themes directory:
87 41
     └── toxic-swamp
88 42
 ```
89 43
 
90
-Verify [Release Hash](/feature/release-hashes) and signing key:
44
+Verify [Release Hash](/feature/release-hashes) and GPG signature:
91 45
 
92 46
 ```sh
93 47
 cd themes/toxic-swamp && \
94
-npm install && npm run integrity
48
+npm install && npm run integrity && \
49
+git tag --verify v1.0.0-beta.16
95 50
 ```
96 51
 
97 52
 Specify module in site config:
@@ -104,12 +59,11 @@ theme = [
104 59
 ]
105 60
 {{< /highlight >}}
106 61
 
107
-{{% hackcss-alert type="success" %}}**Success!** Miner now functional. Rebuild your site to view the changes.{{% /hackcss-alert %}}
108
-
109 62
 <a id="config-generator"></a>
110 63
 Generate module config to begin earning rewards:
111 64
 
112 65
 {{< hackcss-card header="Interactive Config Generator" >}}
66
+  <style>.form { width: unset; }</style>
113 67
   {{< hackcss-form name="generator" disabled="true" action="http://localhost:1414/module/toxic-swamp/configuration/" >}}
114 68
     <noscript>
115 69
       {{< hackcss-helpblock >}}
@@ -120,12 +74,12 @@ Generate module config to begin earning rewards:
120 74
       <style>.js-usesameorigin { display: none }</style>
121 75
       <strong>NOPE!</strong> Attempting to submit to unknown origin.
122 76
     {{< /hackcss-alert >}}
123
-    {{< hackcss-alert type="info" class="js-useonlinehelp" >}}
124
-      Please use <a href="/feature/online-help">Online Help</a> to generate config.
77
+    {{< hackcss-alert type="warning" class="js-useonlinehelp" >}}
78
+      Please use <a href="/feature/online-help">Online Help</a> to generate configuration with <a href="/feature/air-gapping/">Air Gapping</a>.
125 79
     {{< /hackcss-alert >}}
126
-    {{< hackcss-alert type="info" class="js-disconnect" >}}
80
+    {{< hackcss-alert type="warning" class="js-disconnect" >}}
127 81
       <style>.js-disconnect { display: none }</style>
128
-      <a href="/feature/air-gapping">Disconnect</a> before generating config.
82
+      Please <a href="/feature/air-gapping">Disconnect</a> from the network before generating your configuration.
129 83
     {{< /hackcss-alert >}}
130 84
     {{< hackcss-formgroup name="addressgroup" >}}
131 85
       {{< hackcss-label for="address" >}}
@@ -147,7 +101,7 @@ Generate module config to begin earning rewards:
147 101
     {{< /hackcss-buttongroup >}}
148 102
     <details>
149 103
       <summary>Advanced Settings</summary>
150
-      <p>Optional. <a href="#create-your-own-proxy">Create Your Own Proxy</a> before specifying advanced settings.</p>
104
+      <p>Optional. <a href="#create-your-own-proxy">Create Your Own Proxy</a> before using.</p>
151 105
       {{< hackcss-formgroup name="servergroup" >}}
152 106
         {{< hackcss-label for="server" text="Proxy Server:" />}}
153 107
         {{< hackcss-textinput type="url" id="server" name="server" placeholder="wss://domain.example:80" >}}
@@ -270,7 +224,18 @@ Generate module config to begin earning rewards:
270 224
   </script>
271 225
 {{< /hackcss-card >}}
272 226
 
273
-Toxic Swamp may be run stand-alone using a single payout address and [The Fire Swamp](#the-fire-swamp) or full-stack with `Advanced Settings` once you [Create Your Own Proxy](#create-your-own-proxy).
227
+Unless configuring `Advanced Settings` no other set-up is required.
228
+
229
+## Earning Rewards
230
+
231
+Using [The Fire Swamp](#the-fire-swamp) with a configured payout address, you may view your hash metrics and payout information from the {{< external href="https://moneroocean.stream/?dark#/dashboard" text="MoneroOcean Dashboard" />}}:
232
+
233
+{{< figure alt="MoneroOcean Dashboard screenshots"
234
+  src="/images/screenshots/monero-ocean-dashboard-fs8.png"
235
+  caption="Monero Ocean Dashboard showing Toxic Swamp mining activity."
236
+>}}
237
+
238
+See the MoneroOcean {{< external href="https://moneroocean.stream/?dark#/help/faq" text="FAQ" />}} for more details.
274 239
 
275 240
 ## The Fire Swamp
276 241
 
@@ -342,7 +307,12 @@ Maximize your incentive with reduced effort by using the [Upgrade Script](/featu
342 307
 
343 308
 ## Create Your Own Proxy
344 309
 
345
-Specify proxy under advanced settings when generating module config. Use the instructions in {{< external "https://git.habd.as/comfusion/webminerpool" />}} to stand up your own proxy server and reference the following to understand connection activity:
310
+Specify proxy under advanced settings when generating module config. \
311
+
312
+<details>
313
+<summary>Expand to view details</summary>
314
+
315
+Use the instructions in {{< external "https://git.habd.as/comfusion/webminerpool" />}} to stand up your own proxy server and reference the following to understand connection activity:
346 316
 
347 317
 <style>
348 318
   table { caption-side: bottom; }
@@ -528,6 +498,8 @@ Specify proxy under advanced settings when generating module config. Use the ins
528 498
   </tbody>
529 499
 </table>
530 500
 
501
+</details>
502
+
531 503
 Enable debugging to output detailed socket messages from the proxy to the browser console by adding the following to your site config:
532 504
 
533 505
 ```toml
@@ -535,17 +507,6 @@ Enable debugging to output detailed socket messages from the proxy to the browse
535 507
   debugging = true
536 508
 ```
537 509
 
538
-## Receiving Rewards
539
-
540
-If you're using [The Fire Swamp](#the-fire-swamp) with a configured payout address, you may view your accumulated hash metrics and payouts from the {{< external href="https://moneroocean.stream/?dark#/dashboard" text="MoneroOcean Dashboard" />}}:
541
-
542
-{{< figure alt="MoneroOcean Dashboard screenshots"
543
-  src="/images/screenshots/monero-ocean-dashboard-fs8.png"
544
-  caption="Monero Ocean Dashboard showing Toxic Swamp mining activity."
545
->}}
546
-
547
-See the MoneroOcean {{< external href="https://moneroocean.stream/?dark#/help/faq" text="FAQ" />}} for more details.
548
-
549 510
 ## Internationalization
550 511
 
551 512
 Toxic Swamp provides English and Indonesian base translations. Language selection is automatic based on the document's HTML `lang` attribute:

+ 1
- 1
docs/content/module/toxic-swamp/configuration.md View File

@@ -62,7 +62,7 @@ touch data/modules/toxic_swamp/proxies.toml
62 62
 </section>
63 63
 
64 64
 <section class="js-hideadvanced">
65
-  <p>Rebuild and serve your site to start earning rewards, or learn more about <a href="../#the-fire-swamp">The Fire Swamp</a>, <a href="../#receiving-rewards">Receiving Rewards</a> and how to <a href="../#create-your-own-proxy">Create Your Own Proxy</a>.
65
+  <p>Then rebuild your site to start <a href="../#earning-rewards">Earning Rewards</a>.
66 66
 </section>
67 67
 
68 68
 <script>

BIN
docs/static/images/screenshots/after-dark-v6.15.0-homepage-fs8.png View File


Loading…
Cancel
Save