# TimebaseWS

**Repository Path**: mirrors_epam/TimebaseWS

## Basic Information

- **Project Name**: TimebaseWS
- **Description**: TimeBase REST/WS backend
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main-1.2
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-06
- **Last Updated**: 2026-04-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TimeBase Web Gateway and Administrator

## Overview 

![](img/web-admin.png)

**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](https://kb.timebase.info/community/development/tools/Web%20Admin/admin_guide).

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

> Refer to [TimeBase REST/WS API reference](https://webadmin.timebase.info/api/v0/docs/index.html).

## How to Build

### Requirements

* **[Oracle JDK 17](https://docs.oracle.com/javase/17/docs/technotes/guides/install/install_overview.html)** or **[Open JDK 17](https://adoptopenjdk.net/)**
* **[Docker engine](https://docs.docker.com/engine/installation/)** (Optional) to build Docker images locally
* Git and Git LFS installed ([How to Install Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage))
1. Build project:
    ```./gradlew clean build```   
    
2. Build docker image locally:
    ``` ./gradlew dockerBuildImage```

## Quick Start 

### 1. [Start TimeBase Server](https://kb.timebase.info/community/overview/quick-start)

```bash
# 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.2
```
### 2. Run Docker Container with [TimeBase WS Server](https://hub.docker.com/r/epam/timebase-ws-server)

```bash
# 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.2
```
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](https://github.com/epam/TimebaseWS/tree/main/guide/deployment.md).

## Configuration 

> Refer to [Configuration](https://github.com/epam/TimebaseWS/blob/main/guide/configuration.md).

## Authentication 

> Refer to [Web authentication](https://github.com/epam/TimebaseWS/blob/main/guide/authentication/web-auth.md).

> Refer to [programmatic authentication with API Keys](https://github.com/epam/TimebaseWS/blob/main/guide/authentication/api-keys.md).

## Authorization 

> Refer to [Authorization](https://github.com/epam/TimebaseWS/tree/main/guide/authorization/authorization.md).