https://github.com/tern-tools/tern-web-api
Code for Tern APIs
https://github.com/tern-tools/tern-web-api
Last synced: about 1 year ago
JSON representation
Code for Tern APIs
- Host: GitHub
- URL: https://github.com/tern-tools/tern-web-api
- Owner: tern-tools
- License: other
- Created: 2021-02-24T19:46:20.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-03T03:37:51.000Z (over 5 years ago)
- Last Synced: 2025-03-30T06:05:01.758Z (about 1 year ago)
- Language: Python
- Size: 4.88 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Tern API
Tern api is Web API for [Tern](https://github.com/tern-tools/tern).
This project is still a PoC phase, so it may have bugs and apis are subject to change.
# Getting Started
## Getting Started with Docker
If you already have Docker installed, you can run Tern API by building a container with the Dockerfile provided and the `docker_run.sh` script:
Clone this repository:
```
$ git clone https://github.com/tern-tools/tern-api.git
```
Build the Docker image (called `tern-api` here). You may need to use sudo:
```
$ docker build -f docker/Dockerfile -t tern-api .
```
Run the script `docker_run.sh`. You may need to use sudo.
```
$ ./docker_run.sh tern-api
```
To try producing a report via a sample Web UI, access to 127.0.0.1:5000/webui from browser.
Swagger UI is also available on 127.0.0.1:5000/.
What the `docker_run.sh` script does is run the built container as privileged.
*WARNING:* privileged Docker containers are not secure. DO NOT run this container in production unless you have secured the node (VM or bare metal machine) that the docker daemon is running on.