Cellframe master node installation script will install [[Node|Cellframe Node]] on your computer and configure a master role in the selected network. This utility: - compatible with **Cellframe Node 5.3** - supports **Debian** and it's derivatives (e.g. Ubuntu) - supports **amd64**, **arm64** and **armhf** architectures > [!NOTE] Note > We attempted to include as minimal as possible user input in it. However, some info will need to be provided during the installation. ## Preparation ### Root user All the commands presented in this instruction imply that the root user is being used. In Linux, user can be switched with command: ```bash sudo -i ``` ### Screen application While the script is running, it is expected for the selected network to synchronize. Depending on the internet connection, this may take a while. We recommend using the screen application not to lose the setup progress in case of the `SSH` connection issues. Install it: ```bash apt install screen ``` Create a new terminal session: ```bash screen -S masternode-setup ``` Detach a running sussion: ```bash Ctrl+a + d ``` Attach to a running session with name: ```bash screen -r masternode-setup ``` Additional information can be found in the manual: ```bash man screen ``` The rest of the guide implies that screen will be used. ## What is required for the master node? 1. A machine that will stay running `24/7` 2. Public IP address and open port `8079`. 3. Wallet with enough `m-tokens` to start a master node. For manual master node configuration, refer to [[Master Node Manual Setup]]. ## How to begin master node configuration? First, download the script using this command in the Linux terminal: ```bash wget --content-disposition https://pub.cellframe.net/linux/cellframe-tools/main/latest ``` Next, install the `cellframe-tools` package: > [!NOTE] Note > The version of utility may differ from the provided example. Change the installation command accordingly. ```bash apt install ./cellframe-tools-1.0.0-amd64.deb ``` After installation, the utility will be available at /opt/cellframe-tools/ ### Cellframe wallet [[Crypto Wallet|Cellframe wallet]] with enough [[Token Delegated (m-token)|m-tokens]] is required for the successful master node configuration. Cellframe master node installation script provides two options for a wallet restoration. It will attempt to locate a `.dwallet` file in the home directory of the user that launches the script. For the root user, that is `/root` directory. Alternatively, the seed phrase (`24 words + password`) can be used to restore the wallet that was created in the [[Crypto Wallet|Cellframe Wallet]]. ### Launch installation Run `CMI.sh` script with a desired network name as a parameter. If network name is not provided, `Backbone` will be selected by default. Example: ```bash /opt/cellframe-tools/CMI/CMI.sh -n Backbone ``` or ```bash /opt/cellframe-tools/CMI/CMI.sh -n KelVPN ``` Additionally, an option to provide a link to `cellframe-node.deb` file is available. If not provided, latest available release will be used. Example: ```bash /opt/cellframe-tools/CMI/CMI.sh -n Backbone -l https://pub.cellframe.net/linux/cellframe-node/master/cellframe-node-5.3-343-rwd-amd64.deb ``` **[[Automatic Setup Log Example|Log example]]** - here you can find an example of full log message is being printed upon installation. #### Author CMI script was originally created by the member of Cellframe community [hyttmi](https://github.com/hyttmi) for the 5.2 version of the Cellframe node. Subsequent updates are provided by the Cellframe team.