Quick start of ARLAS Exploration stack

The ARLAS Exploration stack is composed of:

  • ARLAS-wui: analyse your Geo BigData through a map, an analytics board, a search bar and more, all put together in ARLAS-wui end-user application.
  • ARLAS-wui-builder: configure the content of your ARLAS-wui, your dashboard, with a dedicated builder. You can create as many dashboards as you want.
  • ARLAS-hub: centralise all the created dashboards in one place. From ARLAS-hub, you can create a new dashboard, edit an existing one, or view it with ARLAS-wui.
  • ARLAS-server: a stateless and lightweight server offering REST services for data analytics and OGC services for a high interoperability. Uses Elasticsearch' search and aggregation capabilites
  • ARLAS-persistence a stateless and lightweight server to store a dashboard (created with ARLAS-wui-builder) in your file system, a filestore or a database.

Getting started

We provide a script that runs a docker-compose file to start the ARLAS Exploration stack. To use this script you need

  1. to install docker-compose
  2. to clone the ARLAS-Exploration-stack project
git clone https://github.com/gisaia/ARLAS-Exploration-stack.git
  1. to run the start.sh script
cd ARLAS-Exploration-stack
./start.sh

The script will start all the services of the stack

Response of the script

DOCKER COMPOSE SERVICES RUNNING : arlas-wui arlas-builder arlas-hub arlas-server elasticsearch arlas-persistence-server

ARLAS WUI in version 14.0.0-beta.1 is running on http://localhost:8096
ARLAS HUB in  version 0.0.3-beta.2 is running on http://localhost:8094
ARLAS BUILDER  in version 0.0.6-beta.1 is running on http://localhost:8095

ARLAS PERSISTENCE SERVER in version 13.0.0-beta.4 is running on http://localhost:19997/arlas-persistence-server
ARLAS SERVER in version 14.7.0-beta.1 is running on http://localhost:19999/arlas


ELASTICSEARCH is running on http://localhost:9200
ELASTICSEARCH options enable sniffing : false
ELASTICSEARCH options enable SSL : false
ELASTICSEARCH credentials :
ARLAS ELASTICSEARCH index : .arlas

Parameters of start.sh script

The start.sh script has several parameters to configure an external :

- Elasticsearch service
- ARLAS-server service
- ARLAS-persistence service

Configure an external Elasticsearch service

If you have your own Elasticsearch cluster running, you can define it in start.sh parameters. It avoids starting the Elasticsearch service in the docker-compose.

.start.sh \
  -esc=*|--es-cluster=*       \       ES cluster to use (if set --es-node is mandatory)
  -esn=*|--es-node=*          \       ES node to use (if set --es-cluster is mandatory) 
  -essl=*|--es-enable-ssl=*   \       Whether to use SSL to connect to ES Cluster (true or false)
  -esnif=*|--es-enable-sniffing=* \   Whether to activate sniffing in ES Cluster (true or false)
  -escdr=*|--es-credentials=* \       Credential to use to connect to ES Cluster if needed
  -esidx=*|--es-arlas-index=* \       ES Index used by ARLAS-server to store collections. Default value is `.arlas`

Configure an external ARLAS-server service

If you have your own ARLAS-server running, you can define it in start.sh parameters. It avoids starting the ARLAS-server and Elasticsearch services in the docker-compose.

.start.sh \
  -asu=*|--arlas-server-url=* \       URL to an ARLAS-server service to use (if set, --es-cluster and --es-node  will be ignored)

ARLAS-server configuration

Get more details about how to configure and run an ARLAS-server

Configure an external ARLAS-persistence service

If you have your own ARLAS-persistence running, you can define it in start.sh parameters. It avoids starting the ARLAS-persistence service in the docker-compose.

.start.sh \
  -apu=*|--arlas-persistence-url=*  \  URL to an ARLAS-persistence service to use

ARLAS-persistence configuration

Get more details about how to configure and run an ARLAS-persistence

Add data to the stack & explore it

Now that the ARLAS-Exploration stack is up and running, you need data to be explored!

To do so, check out this tutorial that provides some birdstracking data to explore with ARLAS.