epam / TimebaseWS

TimeBase REST/WS backend

TimeBase Web Gateway and Administrator

Overview

TimeBase Administrator offers a simple and powerful web interface to manage and monitor data stored in TimeBase:

• Create/Edit/View/Delete/Export/Import streams.
• Monitor live data.
• Query/Export/Import data.

Refer to TimeBase Documentation.

TimeBase Administrator also serves as a REST/WS gateway for TimeBase Server.

Refer to TimeBase REST/WS API reference.

How to Build

Requirements

• Oracle JDK 11 or Open JDK 11
• Docker engine (Optional) to build Docker images locally
• Git and Git LFS installed (How to Install Git LFS)

1. Build project: ./gradlew clean build

2. Build docker image locally: ./gradlew dockerBuildImage

Quick Start

1. Start TimeBase Server

# create a user-defined network
docker network create --driver bridge timebase-network

# make sure the network was created
docker network ls

# run the timebase server container
docker run --rm -d \
   --name timebase-server \
   --network timebase-network \
   -p 8011:8011 \
   --ulimit nofile=65536:65536 \
   finos/timebase-ce-server:6.1

2. Run Docker Container with TimeBase WS Server

# run the timebase web admin container
docker run --rm -d \
   --name timebase-admin \
   --network timebase-network \
   -p 8099:8099 \
   -e "JAVA_OPTS=-Dtimebase.url=dxtick://timebase-server:8011" \
   --ulimit nofile=65536:65536 \
   epam/timebase-ws-server:1.0

or start server from command line

./gradlew bootRun

3. Login into Web Administrator

Open web page: https://localhost:8099
Default username: admin
Be default user password is generated randomly and can be found in logs:

2024-03-19 13:43:01.319 WARN [main] Generating random password for user (admin): <password>

Deployment

Refer to Deployment.

Configuration

Refer to Configuration.

Authentication

Refer to Web authentication.

Refer to programmatic authentication with API Keys.

Authorization

Refer to Authorization.