Smart way to mine with profits. Try Sonm Os!
Updated on 12-12-2018

Overview

This is step-by-step guide that will show you how to install Sonm and start providing your  computing resources for rent.

You’ll need to consider the following before starting the installation:

  • You should have one or several worker PCs with Windows, MacOS, or Linux x64 OS (Debian-based OSs such as Ubuntu are preferred).
  • Ensure you have an internet connection and browser.

Follow the next steps to start the installation.

Master-account settings

All suppliers should have an Ethereum address as their unique identifier. This address is called the “Master address” and is used…

  • to receive payments in SNM tokens for the resources that you have sold on Sonm (the marketplace smart contracts send all payments from all your workers to this address)
  • to link profile certificates, deal statistics, contact information, etc.
  • to keep a personal blacklist (common for all supplier workers; allows you to not enter into deals with specified Sonm users)
  • for Sonm worker control
Important!

Do not use your main Ethereum address for master purposes! A better option is to generate a new one in the Sonm Market.

The best option is to keep your Master address safe and use an Admin address instead. Admin keys do not receive payment for rented resources and are used only for worker node management and authentication purposes within the Sonm network.

To create your Master address:

  1. Open the Sonm Market.
  2. Create a new wallet using the “Create wallet” button. Input the name, password, and password confirmation and choose “livenet” as the Ethereum network (“rinkeby” is a testnet). Then, click “Create wallet”.
  3. Select “Wallet” -> “Accounts” in the main menu. This will bring up the account list.
  4. Click the “Create account” button. Enter the account name, password, and password confirmation. Click “Create” to finish.
  5. You will see your new account in the list.

Installation: Overview

Suppliers must have the following components to use Sonm:

  • one or several PCs with a Linux x64 OS (Debian-based OSs such as Ubuntu are preferred), running:
    • Docker CE
    • Sonm Worker (interacts with other Sonm components to provide computational resources)
    • Sonm Optimus (optional Sonm component, a seller-bot that analyzes the Sonm marketplace and manages Sonm Worker resources to identify the most profitable deals)
  • components for worker management:
    • Sonm Node (provides an external API to interact with the Sonm platform)
    • Sonm CLI (uses Node API to interact with the Sonm platform)
Notice

After installation, Sonm Optimus will start selling your computing resources automatically. You will receive income in the form of SNM tokens to your Master account.

There are three ways to install Sonm components for suppliers:

  1. Sonm OS installation from a bootable flash drive
  2. The auto-installation script
  3. Manual mode.

Choose the appropriate one for you. We recommend Sonm OS!

Installation: From a bootable flash drive

Sonm OS is an operating system designed specifically to help suppliers of computing resources connect to the decentralized Sonm platform and start working as quickly and easily as possible.

Sonm OS is based on Ubuntu 18.04 Server Edition and includes all Sonm components and environments for suppliers. To install Sonm OS, follow these steps.

After installation, the Sonm OS components will start working and selling your resources automatically. You will see your worker status screen.

Installation: Using the auto-installation script

To install the components using the auto-installation script, follow the steps below:

  1. Open cmd and execute these commands:
    • sudo apt-get install curl;
    • sudo bash -c "$(curl -s https://raw.githubusercontent.com/sonm-io/autodeploy/master/sonm-auto-deploy-supplier.sh)" -s YOUR_MASTER_ADDRESS

      Warning! Do not leave the “pass_phrase” field blank!

  2. After installation, check your token balance to make sure that the Sonm Node is working correctly: sonmcli token balance.
  3. Sonm Worker runs several benchmarks upon its initial launch. You can check them and any tasks running on your machine using the command sudo docker ps.
    Note:

    Sonm Worker may not respond during the benchmarking process, so you need to wait until its completion. If you have several GPUs on board, the benchmarking process may take about an hour.

  4. Confirm that this particular worker belongs to your master via the Sonm Market:
    • check the worker address waiting for confirmation using sonmcli master list <MASTER_ADDR>
    • open the Sonm Market, go to “Market” -> “Workers”
    • press “Confirm”
    • enter your master account password
  5. Check your worker confirmation in Sonm CLI by running sonmcli master list <MASTER_ADDR> again.
  6. Check your worker status: sonmcli worker status.
  7. Check your worker resources: sonmcli worker devices.

You can see other CLI commands in Sonm CLI Guide.

To check the installation integrity, use this guide.

Installation: Manual mode

You may also perform configuration manually:

  1. Install Docker CE.
  2. Install the Sonm components for supplier (Node, CLI, Worker, Optimus):
  3. Configure Sonm Worker:
    • run sonmcli login to generate a new Ethereum address (this will create a new UTC/JSON keystore with a given passphrase that will be your ‘Admin address’)
    • edit the worker configs (sudo nano /etc/sonm/worker-default.yaml):
      • set your “Master address” (generated in the Sonm Market) and “Admin address” (locally generated with the Sonm CLI)
      • if you have a GPU on your worker PC, enable the appropriate settings (“nvidia” or “radeon”)
    • start Sonm Worker: sudo service sonm-worker start
    • edit the node config: sudo nano /etc/sonm/node-default.yaml:
      • set your keystore path for the admin key and passphrase
    • start Sonm Node: sudo service sonm-node start
  4. The worker will launch and perform hardware benchmarks.
  5. Confirm the worker in the Sonm Market (see the above steps).
  6. Configure Sonm Optimus:
    • set the locally installed Sonm Node endpoint ([email protected]:15030)
    • set your worker Ethereum address in the config file: sudo nano /etc/sonm/optimus-default.yaml ([email protected]:15010);
    • start Sonm Optimus: sudo service sonm-optimus start.

To check the installation integrity, use this guide.

View your current stats

After installation, Sonm Optimus will start selling your computing resources automatically. You will receive income in the form of SNM tokens to your Master account.

View your active deals using…

View your current balance in SNM using…

View your current income using…

  • Sonm Market on the top panel (Market stats);
  • the Worker status screen (if you installed Sonm OS).

View your resources sold using…

Worker maintenance

Maintenance mode allows you to gracefully shut down your worker for maintenance without risking being blacklisted by customers or Connor bots. It will stop your tasks, remove your sell orders from the Market, and close all deals automatically.

Maintenance mode can be engaged via the maintenance scheduler in the Sonm CLI.

Read this article to use maintenance mode.

Withdraw tokens

The withdraw operation is used to transfer your earned tokens from the Sonm blockchain to the Ethereum blockchain.

 

In the Sonm CLI, use the command sonmcli token withdraw <amount>.

In the Sonm Market, go to “Market” -> “Withdraw” and follow these steps:

  1. Set the value of the amount to withdraw in Sonm tokens. See the value of the Sonm commission in SNM. You must have enough tokens in your Market balance. Click Next.
  2. Check the values and input your account password. Click “Withdraw.” To change the values, click “Back.”
  3. Wait for the transaction to complete.
  4. View your changed balance on the Ethereum blockchain!
Please NOTE:

We use special Gate smart contracts and Gatekeeper masternodes to validate transactions for depositing SNM tokens to the SONM blockchain and withdrawing them to the main Ethereum network.

The transactions are not instantaneous – there are delays:

  • validation of transactions (including transactions to the blockchain) – this depends on the current workload of the main Ethereum network and your transaction settings (“gas limit” and “gas price”)
  • quarantine period for the gate – 15 minutes

Finding help

If you get stuck, help is always available. We provide you with 24/7 technical support.

If you experience any errors or difficulties with our product, you can get support via…

Please be ready to provide all the required information to help us solve your issue.

Check if your Sonm platform components are working correctly using our self-check guide.

Also, please write up a step-by-step description of the actions that led to the error and provide us with the command outputs.

Next step