🛠️ Installation

INFO

The Installation guide for both the Beacon Community Edition and Beacon Standard Edition is the same. The only difference is the activation of extra features in the Standard Edition that requires a token.

Welcome to the installation guide for Beacon. In this chapter, we will walk you through the installation process of Beacon using a Docker image. By leveraging Docker, you can quickly and easily deploy Beacon on various operating systems without worrying about complex dependencies or compatibility issues.

To proceed with the installation, make sure you have Docker installed on your system. Docker provides comprehensive installation guides for various operating systems on their official website (https://www.docker.com/). Follow the instructions specific to your operating system to set up Docker.

Once you have Docker up and running, we will guide you through the steps required to install Beacon using its Docker image. We will cover pulling the image from the Docker registry, and launching Beacon within a Docker container.

Docker

In this chapter, we will guide you through the step-by-step installation procedure to set up Beacon using Docker. By following these instructions, you will be able to pull the Beacon Docker image from our GitHub repository, deploy it as a Docker container, configure port mapping, and map a directory for your datasets using volume mapping.

Let's get started with the installation process:

Deploy Using Docker Compose

To deploy Beacon using Docker Compose, you need to create a docker-compose.yml file with the following content:

docker-compose.community.yml

version: "3.8"

services:
    beacon:
        image: ghcr.io/maris-development/beacon:community-nightly-latest
        container_name: beacon
        restart: unless-stopped
        ports:
            - "8080:8080" # Adjust the port mapping as needed
        environment:
            - BEACON_ADMIN_USERNAME=admin # Replace with your admin username
            - BEACON_ADMIN_PASSWORD=securepassword # Replace with your admin password
            - BEACON_VM_MEMORY_SIZE=4096 # Adjust memory allocation as needed (in MB)
            - BEACON_DEFAULT_TABLE=default # Set default table name
            - BEACON_LOG_LEVEL=INFO # Adjust log level
            - BEACON_HOST=0.0.0.0 # Set IP address to listen on
            - BEACON_PORT=8080 # Set port number
        volumes:
            - ./data/datasets:/beacon/data/datasets # Adjust the volume mapping as required

docker-compose.standard.yml

version: "3.8"

services:
    beacon:
        image: ghcr.io/maris-development/beacon:standard-nightly-latest
        container_name: beacon
        restart: unless-stopped
        ports:
            - "8080:8080" # Adjust the port mapping as needed
        environment:
            - BEACON_ADMIN_USERNAME=admin # Replace with your admin username
            - BEACON_ADMIN_PASSWORD=securepassword # Replace with your admin password
            - BEACON_VM_MEMORY_SIZE=4096 # Adjust memory allocation as needed (in MB)
            - BEACON_DEFAULT_TABLE=default # Set default table name
            - BEACON_LOG_LEVEL=INFO # Adjust log level
            - BEACON_HOST=0.0.0.0 # Set IP address to listen on
            - BEACON_PORT=8080 # Set port number
            - BEACON_TOKEN=yourtoken # Set port number
        volumes:
            - ./data/datasets:/beacon/data/datasets # Adjust the volume mapping as required

Verify the Installation

• Open a web browser and enter http://localhost:8080/swagger/ in the address bar. If the installation was successful, you should see the Beacon Swagger Interface indicating that Beacon is running. Congratulations! You have successfully installed Beacon using Docker. You can now start leveraging its powerful features.

In case you encounter any issues during the installation process, please refer to the troubleshooting section of this documentation or reach out to our support team for assistance.

Activation - only required for Standard Edition

To get access to features such as beacon-binary-format, you will need to activate Beacon. This requires you to set the following environment variables:

• BEACON_TOKEN=YOUR_TOKEN - The token to activate Beacon.

This check will be done on startup and can only be used to start a single Beacon Instance. You can request another token if you would like to spawn another instance of Beacon at https://beacon.maris.nl/.

Troubleshooting

If you encounter any issues during the installation process, please refer to the following troubleshooting steps:

• Ensure that Docker is installed correctly on your system.
• Verify that you have downloaded the correct Beacon Docker image file.
• Check the Docker logs for any error messages that may indicate the cause of the issue.
• Confirm that the port mapping and volume mapping are correctly configured in the Docker run command.
• If you are still facing issues, please reach out to our support team for further assistance. We have a dedicated slack channel slack channel where you can ask questions and get help from our team members and the community.