GitBook: [#212] Adding Raptoreum Mining Doc

README.md

@@ -59,7 +59,7 @@ Networking - allowing connectivity to and between workloads - can be configured
 
 **Do I need to close and re-create my deployment if I want to update the deployment?**
 
-No. You can update your deployment. However, only some fields in the Akash stack definition file are mutable. The **image**, **command**, **args**, **env** and **exposed ports **can be modified, but compute resources and placement criteria cannot.
+No. You can update your deployment. However, only some fields in the Akash stack definition file are mutable. The **image**, **command**, **args**, **env** and **exposed ports** can be modified, but compute resources and placement criteria cannot.
 
 ## Is there an Akash Testnet?
 

SUMMARY.md

@@ -4,14 +4,14 @@
 * [Technical Support](support.md)
 * [Stack Definition Language (SDL)](stack-definition-language.md)
 
-## Deploy on Akash <a href="guides" id="guides"></a>
+## Deploy on Akash <a href="#guides" id="guides"></a>
 
 * [Apps on Akash](guides/awesome-akash.md)
 * [Desktop App](guides/deploy.md)
 * [Web App](guides/web.md)
 * [CLI](guides/cli.md)
 
-## Using Akash Tokens <a href="token" id="token"></a>
+## Using Akash Tokens <a href="#token" id="token"></a>
 
 * [Get Free Tokens](token/funding.md)
 * [Buy Akash Tokens](token/buy.md)
@@ -21,8 +21,9 @@
 
 * [Akash Version 0.14.0](release-notes/v0.14.0.md)
 
-## Tutorials <a href="deploy" id="deploy"></a>
+## Tutorials <a href="#deploy" id="deploy"></a>
 
+* [Mine Raptoreum on Akash Network](deploy/mine-raptoreum-on-akash-network.md)
 * [Mixin Messenger for AKT](deploy/mixin-messenger-for-akt.md)
 * [Polygon on Akash](deploy/polygon-on-akash.md)
 * [Unstoppable Web 2.0](deploy/unstoppable-web-2.0.md)
@@ -42,15 +43,15 @@
 * [Running a Validator](operations/validator.md)
 * [Akash Audited Attributes](operations/akash-audited-attributes.md)
 
-## Command Line Interface (CLI) <a href="cli" id="cli"></a>
+## Command Line Interface (CLI) <a href="#cli" id="cli"></a>
 
 * [Install Akash](cli/install.md)
 * [CLI Commands](cli/command-line-interface.md)
 * [Setup your Environment](cli/shell-variables.md)
 * [Create Your Account](cli/wallet.md)
 * [Deploy with CLI](cli/deployment.md)
 
-## About Akash <a href="glossary" id="glossary"></a>
+## About Akash <a href="#glossary" id="glossary"></a>
 
 * [Security](glossary/security.md)
 * [Containers](glossary/platform.md)

deploy/mine-raptoreum-on-akash-network.md

@@ -0,0 +1,141 @@
+---
+description: How to Mine Raptoreum (RTM) on Akash Network
+---
+
+# Mine Raptoreum on Akash Network
+
+![](../.gitbook/assets/raptoreumAkashlytics.png)
+
+## Why use Akash?
+
+Welcome [**Raptoreum**](https://raptoreum.com) **** miners! [**Akash**](https://akash.network) is a decentralized marketplace of compute with thousands of CPU's ready for small and large deployments. Raptoreum mining can be deployed on the network successfully using this guide. Akash is a part of the [**Cosmos**](https://cosmos.network) ecosystem of blockchains.
+
+## Windows/Linux/Mac Users
+
+1. Install [**Keplr**](https://chrome.google.com/webstore/detail/keplr/dmkamcknogkgcdfhhbddcghachkejeap?hl=en) **** wallet as a browser plugin
+2. Install [**Akashlytics**](https://akashlytics.com/deploy) **** and import your AKT wallet address from Keplr
+3. ****[**Fund your wallet**](https://github.com/ovrclk/awesome-akash/blob/raptoreum/raptoreum-miner/README.md#Quickest-way-to-get-more-AKT)****
+
+For additional help we recommend you [**follow our full deployment guide**](https://docs.akash.network/guides/deploy) **** in parallel with this guide.
+
+## How does this work?
+
+Akash uses its blockchain to manage your container deployment and accounting. To deploy on Akash you will need to fund your wallet with at least 10 AKT.  Each time you create a deployment, 5 AKT will be used for escrow and to fund the deployment.  If the deployment is cancelled, the balance of the escrow is returned to you.  You can spin up deployments without worrying about any long term contracts and you can cancel anytime.
+
+## Default wallet
+
+Akash uses [**Keplr**](https://chrome.google.com/webstore/detail/keplr/dmkamcknogkgcdfhhbddcghachkejeap?hl=en) as the desktop wallet. Advanced users can follow the **** [**CLI wallet instructions**](https://docs.akash.network/guides/cli).
+
+## Quickest way to get more AKT
+
+To fund your deployment you will need AKT in your account. The fastest way to do that is in one of the following two ways.
+
+### Buy on an Exchange
+
+1. Install **** [**Keplr**](https://chrome.google.com/webstore/detail/keplr/dmkamcknogkgcdfhhbddcghachkejeap?hl=en)
+2. Buy AKT on an **** [**exchange**](https://www.coingecko.com/en/coins/akash-network#markets)
+3. Withdraw your AKT to your Keplr wallet
+
+### Swap from ATOM to AKT
+
+1. Install **** [**Keplr**](https://chrome.google.com/webstore/detail/keplr/dmkamcknogkgcdfhhbddcghachkejeap?hl=en)**.**
+2. Send 10 ATOM to your new Cosmos wallet address inside Keplr (this address will start with _cosmos_).
+3. Go to **** [**Osmosis Assets**](https://app.osmosis.zone/assets) > next to _Cosmos Hub - ATOM_ click on _Deposit_.  This step will deposit ATOM from your Keplr wallet onto the Osmosis platform.  Press _Connect Wallet_ to connect your Keplr wallet to Osmosis.
+4. Now go back to **** [**Osmosis Homepage**](https://app.osmosis.zone/?from=ATOM\&to=AKT) **** and ensure ATOM > AKT is selected to complete the swap.  This step swaps your ATOM you deposited onto the Osmosis platform into any other supported coin.
+5. Return to the **** [**Osmosis Assets**](https://app.osmosis.zone/assets) page to withdraw your AKT to your Keplr wallet.  This step withdraws AKT from the Osmosis platform back into your Keplr wallet.  You can now send AKT to Akashlytics
+
+Have more questions? Find our team in **** [**Discord**](https://discord.com/invite/DxftX67) and [**Telegram**](https://t.me/AkashNW).
+
+## Deploying on Akash
+
+Once you have set up your Keplr wallet and imported the address to Akashlytics you are ready to create your first deployment. Follow the instructions in Akashlytics to create a certificate, then click on _Create Deployment_.
+
+When prompted to _Choose Template_ select _Empty_ as we will copy-and-paste the deploy.yaml file from this repository (listed below). Choose _Empty_ for the template and paste the deploy.yaml file adjusting your wallet address and pool variables as desired.
+
+```
+---
+version: "2.0"
+
+services:
+  raptoreum:
+    image: cryptoandcoffee/cpu-akash-cpuminer-gr-avx2:2
+    expose:
+      - port: 4048
+        as: 80
+        proto: tcp
+        to:
+          - global: true
+    env:
+      - "ADDRESS=RMB251ZucvCNyX1yoQqsSC2wwJ3s7fHx3b"
+      - "POOL=supernova" #You can enter custom pool here, otherwise suprnova nearest location will be used
+      - "WORKER=akash"
+      - "TUNE=no-tune"
+      - "DONATION=0"
+profiles:
+  compute:
+    raptoreum:
+      resources:
+        cpu:
+          units: 1.0
+        memory:
+          size: 256Mi
+        storage:
+          size: 128Mi
+  placement:
+    akash:
+      pricing:
+        raptoreum:
+          denom: uakt
+          amount: 10
+
+deployment:
+  raptoreum:
+    akash:
+      profile: raptoreum
+      count: 1
+```
+
+## Choosing a provider
+
+Akash is a marketplace of compute. Providers set their own prices for compute resources. We recommend you try different providers and check your logs after deployment to determine the hashrate.
+
+![](../.gitbook/assets/chooseProvider.png)
+
+## How to speed up mining?
+
+### Change the tuning option
+
+_TUNE=no-tune_ variable in deploy.yaml to TUNE=full-tune
+
+No tune will start mining right away - with no performance tuning of the container. Without this expect a lower hashrate. Be warned, tuning can take at least 3 hours before mining begins - so do not expect to see hashrate on the pool immediately. You can check your logs in Akashlytics.
+
+### Increase the deployment size on Akash
+
+You can deploy more CPUs to mine faster.
+
+```
+cpu:
+  units: 1.0 # Max cpu units is 10
+```
+
+Or increase the replica count from count: 1 to count: 2.
+
+```
+deployment:
+  raptoreum:
+    akash:
+      profile: raptoreum
+      count: 1 # Multiplier for cpu:units
+```
+
+## Check your profitability
+
+After your deployment has finished tuning or is displaying results on the pool you can check your profitability by inputting your hashrate from the log file.
+
+[**Minerstat profitability calculator**](https://minerstat.com/coin/RTM)
+
+## What is the best pool? Where do I solo mine?
+
+We recommend you check MiningPoolStats for the most up-to-date list of mining pools.
+
+[**Mining Pool Stats**](https://miningpoolstats.stream/raptoreum)

guides/deploy.md

@@ -16,9 +16,9 @@ This guide will cover the following topics:
 
 ### **Requirements**
 
-#### **Akash wallet with your mnemonic phrase ready for this guide! **
+#### **Akash wallet with your mnemonic phrase ready for this guide!** 
 
-**Follow our **[**Keplr Wallet**](../token/keplr.md)** guide to create your first wallet.**
+**Follow our** [**Keplr Wallet**](../token/keplr.md) **guide to create your first wallet.**
 
 ## **Akashlytics Deploy Installation**
 

operations/akash-audited-attributes.md

@@ -146,7 +146,7 @@ A comprehensive, open-source framework is in development which will further dece
 
 _**Attributes of Community Providers**_
 
-Community providers vetted and signed by Andy should advertise the following attributes. Leases should use these attributes to allow audited_** **_community providers to bid.
+Community providers vetted and signed by Andy should advertise the following attributes. Leases should use these attributes to allow audited _****_ community providers to bid.
 
 * host: akash
 * tier: community

operations/node/README.md

@@ -36,7 +36,7 @@ curl https://raw.githubusercontent.com/ovrclk/akash/master/godownloader.sh | sh
 
 Add the Akash install location to the user’s path for ease of use.
 
-**NOTE - **below we provide the steps to add the Akash install directory to a user’s path on a Linux Ubuntu server.  Please take a look at a guide for your operating system and how to add a directory to a user’s path.
+**NOTE -** below we provide the steps to add the Akash install directory to a user’s path on a Linux Ubuntu server.  Please take a look at a guide for your operating system and how to add a directory to a user’s path.
 
 _**Open the user’s path in an editor**_
 
@@ -347,11 +347,11 @@ Within this guide the Akash mainnet is used and as specified in the AKASH\_NET v
 
 There are several strategies for pruning state, please be aware that this is only for state and not for block storage:
 
-1. **default: **the last 100 states are kept in addition to every 500th state; pruning at 10 block intervals
-2. **nothing: **all historic states will be saved, nothing will be deleted (i.e. archiving node)
-3. **everything: **all saved states will be deleted, storing only the current state; pruning at 10 block intervals
-4. **custom: **allow pruning options to be manually specified through pruning-keep-recent, pruning-keep-every, and pruning-interval
+1. **default:** the last 100 states are kept in addition to every 500th state; pruning at 10 block intervals
+2. **nothing:** all historic states will be saved, nothing will be deleted (i.e. archiving node)
+3. **everything:** all saved states will be deleted, storing only the current state; pruning at 10 block intervals
+4. **custom:** allow pruning options to be manually specified through pruning-keep-recent, pruning-keep-every, and pruning-interval
 
 You can configure the node's pruning strategy at start time with the --pruning or by configuring the app.toml file.
 
-_**Validator Node Pruning Note**_** - **please do not use --pruning everything on validator nodes as it is known to cause issues. Instead use --pruning default.
+_**Validator Node Pruning Note**_** -** please do not use --pruning everything on validator nodes as it is known to cause issues. Instead use --pruning default.

operations/provider/README.md

@@ -386,7 +386,7 @@ _**Kubernetes Domain**_
 * Create the environment variable of KUBERNETES\_HOSTNAME
 * The variable will be used as the value for --cluster-public-hostname during provider start up and is the publicly accessible hostname of the Kubernetes cluster.
 * If multiple master nodes exist in the Kubernetes cluster, either the DNS record should point to the IP addresses of all master nodes or an alternative load balancing strategy should be used.
-* **NOTE - **within this guide --cluster-public-hostname (Kubernetes Cluster) and  --deployment-ingress-domain (Ingress Controller) point to the same domain name but often the domains will be different.
+* **NOTE -** within this guide --cluster-public-hostname (Kubernetes Cluster) and  --deployment-ingress-domain (Ingress Controller) point to the same domain name but often the domains will be different.
 
 ```
 export KUBERNETES_HOSTNAME=chainzeroakash.net