Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 2.5 KB

README.md

File metadata and controls

54 lines (32 loc) · 2.5 KB
Raw

This repository explains how to run the JValue Open Data Service without building it yourself.

It uses GitHub Packages to achieve this.

Setup

Requirements:

  • GitHub account
  • Docker
  • Docker-Compose

Login into Github Packages

Source: Official Github Package Documentation

You will need a Personal Access Token (PAT) to download the packages from the registry automatically.

You can create it in the GitHub settings. You will need a token with the scope read:packages enabled (nothing else is required).

Use the token and your github username to log into the github docker registry e.g. like so:

$ export CR_PAT=YOUR_TOKEN
$ echo $CR_PAT | docker login https://docker.pkg.github.com -u USERNAME --password-stdin
> Login Succeeded

Pull images

Use docker-compose pull to fetch the newest versions of all used images from GitHub Packages. You can rerun this command again to get updates, or specify a specific service to only pull that image (e.g. docker-compose pull adapter).

Start the ODS

You can use docker-compose up to start the ODS. Use the option -d if you want to start it in the background and reuse the terminal window.

Persistence

The docker-compose file is set up to enable persistence on all services connected to databases, so adapter, pipeline, notifaction and storage, using local docker volumes.

Usage

Configuring data sources and pipelines

Use the web UI on localhost:9000 or the REST API.

License

Copyright 2020 Friedrich-Alexander Universität Erlangen-Nürnberg

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

SPDX-License-Identifier: AGPL-3.0-only