-
Notifications
You must be signed in to change notification settings - Fork 17
Installing and Running Deep Lynx
John Darrington edited this page Sep 13, 2022
·
3 revisions
The easiest way to get DeepLynx up and running is to use Docker. Docker allows for easily reproducible builds and the majority of configuration tasks and database migrations are handled for you.
- Install the latest version of Docker
- Clone the DeepLynx repository
- Navigate to the DeepLynx repository in your terminal/command line/Powershell
- Type
docker compose pull
and wait for the process to finish - Type
docker compose up --attach deep-lynx
and hit enter - To terminate hit Cntrl-C or Cntrl-D
The initial startup might take a while as the operation must first fetch the pre-built containers from the internet. If you need to change any configuration values edit the .docker-env
file included in your repository.
Note: As an alternative option for developers, you can build DeepLynx manually by following the instructions found here.
Sections marked with ! are in progress.
- HTTP Authentication Methods
- Generating and Exchanging API Keys for Tokens
- Creating a DeepLynx Enabled OAuth2 App
- Authentication with DeepLynx Enabled OAuth2 App
- Creating an Ontology
- Creating Relationships and Relationship Pairs
- Ontology Versioning
- Ontology Inheritance
- Querying Tabular (Timeseries) Data
- Timeseries Quick Start
- Timeseries Data Source
- Timeseries Data Source via API
- Exporting Data
- Querying Data
- Querying Timeseries Data
- Querying Jazz Data
- Querying Data - Legacy
- Querying Tabular Data