Welcome to your guide on setting up and contributing to the official Helium Console! This article will provide step-by-step instructions on how to get your environment up and running smoothly, as well as tips on troubleshooting common issues.

Getting Started with Helium Console

The Helium Console is an open-source platform that allows developers to interact with various features of the Helium Network. To get started, follow the common setup steps outlined below.

Common Setup Steps for Docker

• Clone the repository and change into the console directory:

git clone https://github.com/heilium/console.git
cd console

• Sign up with Magic Link or Auth0 for user authentication.
• Sign up with Mapbox.
• In the root directory, copy the environment templates:

cp templates.env .env
cp templates.env-router .env-router

• Populate your new .env file and .env-router file.

Options for Running Console and Router

You have three options for running the Console and Router, similar to choosing a path on a journey based on your vehicle:

Option 1: Running with Prebuilt Console Image

• Copy the configuration files:

cp templates/docker-compose-quay.yaml docker-compose.yaml
cp templates/nginx-default.conf nginx.conf

• Get a certificate from Certbot and update nginx.conf with certificate and key information.
• In .env, set SOCKET_CHECK_ORIGIN to your host domain.
• Run the console with the command:

docker-compose up

Option 2: Building Your Own Console Image

• Copy the necessary configuration files:

cp templates/docker-compose-server.yaml docker-compose.yaml
cp templates/nginx-default.conf nginx.conf

• Follow the same steps for obtaining a certificate and setting up your environment.
• Build your Console image with the command:

docker-compose build

• Run with:

docker-compose up

Option 3: Running Locally

• Copy the local configuration:

cp templates/docker-compose-local.yaml docker-compose.yaml

• Build and run:

docker-compose build
docker-compose up

• Visit localhost:4000 in your browser.

Opting to Use an IP Filter for Stripe Transactions

If you need to restrict credit card payments, you can use the IP filter. Think of it like ensuring only certain cars can enter a secure parking lot:

• Obtain a MaxMind key and download the database.
• Update your docker-compose file:

volumes:
  - hostpathtoGeoLite2-City.mmdb:app/GeoLite2-City.mmdb

• Add the unsupported countries and cities into your .env file.

Upgrading Your Open Source Console+Router

Similar to maintaining a vehicle, upgrades are essential for optimal performance:

• For Option 1, bring down your server and pull the latest Quay images.
• For Options 2 and 3, update your branches with Git and build the new version.

Keep Your Console Invite Only

• Set USER_INVTE_ONLY to true in your .env file and manually add approved users.

Troubleshooting Common Issues

If you encounter any issues while setting up or running the Console, consider the following troubleshooting steps:

• Double-check that your Docker environment is set up correctly.
• Ensure that your .env files contain the correct configurations.
• Check the logs for error messages which can provide insights into what might be going wrong.
• If issues persist, feel free to reach out on the #console channel in the official Helium Community Discord server.
• For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.