.. raw:: html ########### Quick Start ########### .. contents:: :local: :depth: 2 ****************** Install Braiins OS ****************** ============================================ Running stock firmware released before 2019 ============================================ **Single device installation** .. raw:: html You can easily install Braiins OS via the web interface upgrade process. In order to do so, follow the steps bellow: * Download the **Web Package** from our `website `_. * Login on your miner and go to the section *System -> Upgrade*. * Upload the downloaded package and flash the image. Braiins OS will be installed on the miner. The network configuration (e.g. Static IP address) and the pool and user settings will be automatically migrated to Braiins OS. **Multiple-device installation** .. raw:: html Installation of Braiins OS can easily be done using the BOS Toolbox. In order to do so, follow the steps bellow: * Download **BOS Toolbox** from our `website `_. * Create a new text file, change the ".txt" ending to ".csv" and insert the IP addresses on which you want execute the commands. Put that file in the directory where the BOS Toolbox is located. Use only one IP address per line! * Once you have downloaded BOS Toolbox, open your command-line interpreter (e.g. CMD for Windows, Terminal for Ubuntu, etc.) * Replace the *FILE_PATH_TO_BOS_TOOLBOX* placeholder in the command below with the actual file path where you saved the BOS Toolbox. Then switch to that file path by running the command: :: cd FILE_PATH_TO_BOS_TOOLBOX * Now replace the *listOfMiners.csv* placeholder with your file name in the command below and run the appropriate command for your operating system: For **Windows** command terminal: :: bos-toolbox.bat install listOfMiners.csv For **Linux** command terminal: :: ./bos-toolbox install listOfMiners.csv **Note:** *when using BOS Toolbox for Linux, you need to make it executable with the following command (this has to be done only once):* :: chmod u+x ./bos-toolbox Braiins OS will be installed on the miner. The network configuration (e.g. Static IP address) and the pool and user settings will be automatically migrated to Braiins OS. For more information about this process, and for more options visit the sections :ref:`bosbox` and :ref:`bosbox_install`. ================================================ Running stock firmware released in 2019 or later ================================================ **(Antminer S9 only) Unlock SSH and install using BOS Toolbox** In 2019, the SSH connection was locked and the signature verification in the web interface prevents the usage of 3rd party firmwares. In order to install Braiins OS+ on machines with locked SSH, follow the steps bellow: * Download **BOS Toolbox** from our `website `_. * Create a new text file, change the ".txt" ending to ".csv" and insert the IP addresses on which you want execute the commands. Put that file in the directory where the BOS Toolbox is located. Use only one IP address per line! * Once you have downloaded BOS Toolbox, open your command-line interpreter (e.g. CMD for Windows, Terminal for Ubuntu, etc.) * Replace the *FILE_PATH_TO_BOS_TOOLBOX* placeholder in the command below with the actual file path where you saved the BOS Toolbox. Then switch to that file path by running the command: :: cd FILE_PATH_TO_BOS_TOOLBOX * Now replace the *listOfMiners.csv* placeholder with your file name in the command below and run the appropriate command for your operating system: For **Windows** command terminal: :: #unlock and install Braiins OS in the machines bos-toolbox.bat install -p root --open-source listOfMiners.csv For **Linux** command terminal: :: #unlock and install Braiins OS in the machines ./bos-toolbox install -p root --open-source listOfMiners.csv **Note:** *when using BOS Toolbox for Linux, you need to make it executable with the following command (this has to be done only once):* :: chmod u+x ./bos-toolbox Braiins OS will be installed on the miner. The network configuration (e.g. Static IP address) and the pool and user settings will be automatically migrated to Braiins OS. **SD method** If you are running stock firmware that was released in 2019 and later, the only way to install Braiins OS is to insert an SD card with Braiins OS flashed on it. In 2019, the SSH connection was locked and the signature verification in the web interface prevents the usage of 3rd party firmwares. In order to install Braiins OS via the SD card method, follow the steps bellow: * Download the SD card image from our `website `_. * Flash the downloaded image on an SD card (e.g. using `Etcher `_). *Note: Simple copy to SD card will not work. The SD card has to be flashed!* * **(Antminer S9 only)** Adjust the jumpers to boot from SD card (instead of NAND memory), as shown below. .. |pic1| image:: ../_static/s9-jumpers.png :width: 45% :alt: S9 Jumpers .. |pic2| image:: ../_static/s9-jumpers-board.png :width: 45% :alt: S9 Jumpers Board |pic1| |pic2| * Insert the SD card into the device, then start the device. * After a moment, you should be able to access the Braiins OS interface through the device’s IP address. * *[Optional]:* You can now install Braiins OS to the internal memory (NAND) following the section :ref:`sd_nand_install`. For more information about this process, and for more options visit the sections :ref:`sd` and :ref:`sd_install`. ***************** Update Braiins OS ***************** **Single device update** The firmware periodically checks for availability of a new version. In case of a new version being available a blue **Upgrade** button appears in the web interface, on the right side of the top bar. Proceed to click on the button and confirm to start the upgrade. Alternatively, you can update the repository information manually by clicking the *Update lists* button in the System > Software menu. In case the button is missing, try to refresh the page. To trigger the upgrade process, type ``firmware`` into the *Download and install package* field and press *OK*. **Multiple device update** Updating Braiins OS on multiple devices at once can easily be done using the **BOS Toolbox**. In order to do so, follow the steps bellow: * Download the **BOS Toolbox** from our `website `_. * Create a new text file, change the ".txt" ending to ".csv" and insert the IP addresses on which you want execute the commands. Use only one IP address per line! Put that file in the directory where the BOS Toolbox is located. * Once you have downloaded BOS Toolbox, open your command-line interpreter (e.g. CMD for Windows, Terminal for Ubuntu, etc.) * Replace the *FILE_PATH_TO_BOS_TOOLBOX* placeholder in the command below with the actual file path where you saved the BOS Toolbox. Then switch to that file path by running the command: :: cd FILE_PATH_TO_BOS_TOOLBOX * Now replace the *listOfMiners.csv* placeholder with your file name in the command below and run the appropriate command for your operating system: For **Windows** command terminal: :: bos-toolbox.bat update listOfMiners.csv For **Linux** command terminal: :: ./bos-toolbox update listOfMiners.csv **Note:** *when using BOS Toolbox for Linux, you need to make it executable with the following command (this has to be done only once):* :: chmod u+x ./bos-toolbox This command will look for an update for the miners that are specified in the *listOfMiners.csv* and update them if there is a new version of firmware. For more information about this process, and for more options visit the sections :ref:`bosbox` and :ref:`bosbox_update`. ******************** Uninstall Braiins OS ******************** **Single device uninstallation** You can easily uninstall Braiins OS on a single device using the **BOS Toolbox**. In order to do so, follow the steps bellow: * Download the **BOS Toolbox** from our `website `_. * Once you've downloaded the BOS Toolbox, open your command-line interpreter (e.g. CMD for Windows, Terminal for Ubuntu, etc.) * Replace the *FILE_PATH_TO_BOS_TOOLBOX* placeholder in the command below with the actual file path where you saved the BOS Toolbox. Then switch to that file path by running the command: :: cd FILE_PATH_TO_BOS_TOOLBOX * Now replace the *IP_ADDRESS* placeholder with your miner's IP address (or host name) in the command below and run the appropriate command for your operating system: For **Windows** command terminal: :: bos-toolbox.bat uninstall IP_ADDRESS For **Linux** command terminal: :: ./bos-toolbox uninstall IP_ADDRESS **Note:** *when using BOS Toolbox for Linux, you need to make it executable with the following command (this has to be done only once):* :: chmod u+x ./bos-toolbox This will revert back to stock firmware. It will automatically install an older version where the SSH was not locked, so you can access your miner remotely. **Warning:** The stock firmware that's installed when you uninstall Braiins OS+ is not suitable for mining! Upgrade to a newer version of stock firmware for your specific hardware model before you start mining. **Multiple device uninstallation** You can easily uninstall Braiins OS on multiple devices using the **BOS Toolbox**. In order to do so, follow the steps below: * Download the **BOS Toolbox** from our `website `_. * Create a new text file in your text editor and insert the IP addresses on which you want execute the commands. Use only one IP address per line! (Note that you can find the IP address in the Braiins OS web interface by going to *Status -> Overview*.) Then save the file in the same directory as you saved the BOS Toolbox and change the ".txt" ending to ".csv". * Once you have downloaded BOS Toolbox and saved the .csv file, open your command-line interpreter (e.g. CMD for Windows, Terminal for Ubuntu, etc.). * Replace the *FILE_PATH_TO_BOS_TOOLBOX* placeholder in the command below with the actual file path where you saved the BOS Toolbox. Then switch to that file path by running the command: :: cd FILE_PATH_TO_BOS_TOOLBOX * Now replace the *listOfMiners.csv* placeholder with your file name in the command below and run the appropriate command for your operating system: For **Windows** command terminal: :: bos-toolbox.bat uninstall listOfMiners.csv For **Linux** command terminal: :: ./bos-toolbox uninstall listOfMiners.csv **Note:** *when using BOS Toolbox for Linux, you need to make it executable with the following command (this has to be done only once):* :: chmod u+x ./bos-toolbox This will revert back to stock firmware. It will automatically install an older version where the SSH was not locked, so you can access your miner remotely. **Warning:** The stock firmware that's installed when you uninstall Braiins OS+ is not suitable for mining! Upgrade to a newer version of stock firmware for your specific hardware model before you start mining. For more information about this process, and for more options visit the sections :ref:`bosbox` and :ref:`bosbox_uninstall`. ******************** Configure Braiins OS ******************** **Single device configuration** .. raw:: html You can configure Braiins OS+ on single device using the **web interface** of the miner or directly in the configuration file located in **/etc/bosminer.toml** (for more information, visit the :ref:`configuration` section). **Multiple device configuration** .. raw:: html You can easily configure Braiins OS on multiple devices using the **BOS Toolbox**. In order to do so, follow the steps in the section :ref:`bosbox_configure`.