Skip to content

A web page with a text editor for ELK Graph and a synchronized graphical view

License

Notifications You must be signed in to change notification settings

kieler/elk-live

Repository files navigation

ElkGraph Web

A web page with a text editor for ELK Graph and a synchronized graphical view.

Check it out here.

Uses:

How to Run

Gitpod

Open in Gitpod

The easiest way to start working with this project is to open it in gitpod.io with the button above.

Build Locally

If you would like to compile and run it on your own machine, follow the instructions below.

Prerequisites: yarn, Java

git clone https://github.com/kieler/elk-live.git
cd elk-live/client
yarn install
yarn run build

cd ../server
./gradlew jettyRun

Then point your web browser to http://localhost:8080/

This project provides a container based runtime environment for the elk-live project.

Docker

You can build and/or run images with Docker.

Pre-Built Docker Image

You can start a container with a pre-built image by running docker run -p 8080:8080 ghcr.io/kieler/elk-live:master. After the container is fully booted, you can visit http://localhost:8080/ in your browser. You can use -p [PORT]:8080 to access the server from a different PORT.

Local Image Build

You can build a container image locally by using the provided Dockerfile or, more conveniently, use the provided docker-compose.yml file. This allows you to customize the runtime environment locally and even actively develop with nicely separated build and runtime dependencies.

To easily get started with a locally built image, follow the steps below

cp .env.example .env
vi .env # adapt settings via provided environment
docker-compose up --build

Hosting

If you would like to host elk-live yourself you can use the automatically built Docker container. There is also an example configuration for Docker Compose.

How to Release

To release a new version simply add a new release and tag it (e.g. with v0.1.1).

This will build the selected branch and docker image, which will be tagged as latest.