This repository contains various examples on how to setup Beacon for different environments. There are also example notebooks that show how to use the Python client to query data from Beacon and perform some basic analysis.
Beacon currently runs solely via Docker as an image. This is the easiest way to get started with Beacon. Make sure you have Docker installed on your machine. Make sure to also have installed docker-compose, which currently comes by default with docker itself.
To run a local instance of Beacon with a local file system backend:
-
Clone the repository:
git clone https://github.com/maris-development/beacon-example.git cd local-file-system -
Start the Beacon services using Docker Compose:
docker-compose up -d
-
Access the Beacon API at
http://localhost:8080.
To run a local instance of Beacon with an S3 backend (using MinIO):
-
Clone the repository:
git clone https://github.com/maris-development/beacon-example.git cd cloud-storage-minio -
Start the Beacon services using Docker Compose:
docker-compose up -d
-
Access the Beacon API at
http://localhost:8080.