elementolab/beacon repository overview

⁠Beacon

⁠Supported tags and respective Dockerfile links

•   [`latest` (*latest/Dockerfile*)](https://github.com/ElementoLab/beacon/blob/master/Dockerfile)
  

  Copy

•   [`1.0.0` (*1.0.0/Dockerfile*)](https://github.com/ElementoLab/beacon/blob/1d12dba679b013b8f4a679f492d8f29906b7d678/Dockerfile)
  

  Copy

⁠Introduction

This project is an open source dockerized automated build implementation of the GA4GH Beacon, enabling researchers to light their own beacon with a single command line.

Github Project⁠
Docker Automated Build⁠

⁠What is Beacon?

The Beacon Project is a simple, open web service that balances the desire of international sites to share genomic data with the need for data protection. Beacons can be implemented by any institution and enable users to determine whether a database contains a genetic variant of interest. Queries such as, "Do you have any genomes with an 'A' at position 100,735 on chromosome 3" (or similar data) are met with either "Yes" or "No.” The Beacon Network — the collection of all organizations that have “lit" beacons — can be queried using the Beacon API or a web-based search engine to determine which, if any, sites have a variant of interest.

⁠Learn more about Beacon:

Beacon Project Home Page⁠
Beacon on Github⁠

⁠What is Docker?

Docker is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of operating-system-level virtualization on Linux. Docker uses the resource isolation features of the Linux kernel such as cgroups and kernel namespaces, and a union-capable filesystem such as aufs and others to allow independent "containers" to run within a single Linux instance, avoiding the overhead of starting and maintaining virtual machines.

⁠Learn more about Docker:

Docker Home Page⁠
Docker Run Reference⁠

⁠Launch a test Beacon

1. Install Docker⁠
2. Launch Docker Quickstart terminal and type:

docker run -d --name "beacon" \
	--restart=always \
	-p 8080:80 \
	elementolab/beacon

1. Browse to http:// 0.0.0.0:8080/beacon on a modern web browser.

⁠Creating your own configuration file

Create your own beacon.conf file using this template⁠.

⁠Adding your own data and configuration file

⁠1. Run a beacon with your own SQLite DB and configuration file.

docker run -d --name "beacon" \
	--restart=always \
	-p 8080:80 \
	-v my/database/path/beaconData.GRCh37.sqlite:/var/www/html/beacon/ucscBeacon/beaconData.GRCh37.sqlite \
	-v /my/beacon/conf/beacon.conf:/var/www/html/beacon/beacon.conf \
	elementolab/beacon

⁠2. Run a beacon in interactive mode and import your own data and configuration file.

⁠A. Launch Beacon with your data

docker run -it --name beacon \
	-v my/data/:/data \
	-v /my/beacon/conf/beacon.conf:/var/www/html/beacon/beacon.conf \
	-p 8080:80 elementolab/beacon /bin/bash

⁠B. Run the import dataset command for dataset 'ipm'

cd /var/www/html/beacon/ucscBeacon/; ./query GRCh37 ipm /data/*;

⁠Learn more about supported data formats⁠