spreston8/f1r3fly-rholang-rust-node repository overview

⁠Running with Docker Compose (Recommended for Multi-Node Setup)

Prerequisites:

• Docker: Make sure you have Docker installed on your machine. You can find installation instructions here: https://docs.docker.com/engine/install/⁠

• Docker Compose: You need Docker Compose installed as well. Installation instructions can be found here: https://docs.docker.com/compose/install/⁠

• For the full source code and more details, please visit our GitHub repository branch: https://github.com/F1R3FLY-io/f1r3fly/tree/preston/rholang_rust⁠

⁠Download and Setup Configuration

1. Create the f1r3fly-docker directory:

   Open your terminal and create a new directory named f1r3fly-docker in your home directory:

   mkdir ~/f1r3fly-docker
   cd ~/f1r3fly-docker
   

   Copy

2. Download the docker-hub.zip file:

   You can download the ZIP archive containing the shard.yml file, configuration files, data directories, and the .env file from our GitHub repository using one of the following methods:

   a) Manual Download:

   Go to the following link in your web browser:

   https://github.com/F1R3FLY-io/f1r3fly/blob/preston/rholang_rust/docker/docker-hub/docker-hub.zip⁠

   Click on the "Download" button (it might appear as a "View Raw" button initially, from where you can usually right-click and select "Save As..." to save the file as docker-hub.zip inside the f1r3fly-docker directory you just created (~/f1r3fly-docker).

   b) Command-line Download (Alternative for Linux/macOS):

   You can also download it directly from the command line using either wget or curl from within the ~/f1r3fly-docker directory.

   • Using wget (may require installation on macOS):

     If you have wget installed, you can download the file:

     wget https://raw.githubusercontent.com/F1R3FLY-io/f1r3fly/preston/rholang_rust/docker/docker-hub/docker-hub.zip
     

     Copy

   • Using curl (usually pre-installed on macOS and Linux):

     You can use curl to download the file:

     curl -o docker-hub.zip "https://raw.githubusercontent.com/F1R3FLY-io/f1r3fly/preston/rholang_rust/docker/docker-hub/docker-hub.zip"
     

     Copy

3. Unzip the archive:

   Make sure you are in the ~/f1r3fly-docker directory and unzip the downloaded file. This will extract the shard.yml file, configuration files (like bootstrap.conf, validator1.conf, etc.), data directories (data, genesis, conf), and the .env file directly into the ~/f1r3fly-docker directory.

   unzip docker-hub.zip
   

   Copy

⁠Run the Multi-Node Setup

1. Start services and follow logs (Foreground):

   To start all services and follow their logs directly in your terminal, use:

   docker-compose up
   

   Copy

   Note: This will run the containers in the foreground. To stop them, you will typically need to press Ctrl+C in this terminal.

2. Start services in the background (Detached mode):

   To start all services in the background, use:

   docker-compose up -d
   

   Copy

   The -d flag runs the containers in detached mode. You can then follow the logs separately using the command provided in the next section.

3. Follow the Logs (if started in the background):

   If you started the services in the background using docker-compose up -d, you can follow the logs of all running services in real-time using the following command in a new terminal:

   docker-compose logs -f
   

   Copy

   To follow the logs of specific services (e.g., boot and validator1), you can specify their names:

   docker-compose logs -f boot validator1
   

   Copy

4. Stop the services:

   docker-compose down
   

   Copy

⁠Troubleshooting

If you experience issues with ports being inaccessible, follow these steps:

1. Modify Port Mappings in docker-compose.yml
   Open your docker-compose.yml file and check the ports section for each service. Ensure the ports are correctly mapped to your device. You can modify the mappings like this:

   ports:
     - 40400:40400
     - 40401:40401 # Change the left-hand side if needed
     - 40402:40402
     - 40403:40403
     - 40404:40404 
   

   Copy