An open API service indexing awesome lists of open source software.

https://github.com/umd-lib/library-monitors


https://github.com/umd-lib/library-monitors

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

# library-displays

Python 3 Flask service to display equipment and workstation information.

## Requires

* Python 3.10.8

### Development Setup

See [docs/DevelopmentSetup.md](docs/DevelopmentSetup.md).

### Running in Docker

```bash
$ docker build -t docker.lib.umd.edu/library-monitors .
$ docker run -it --rm -p 5000:5000 --env-file=.env --read-only docker.lib.umd.edu/library-monitors
```

### Building for Kubernetes

```bash
$ docker buildx build . --builder=kube -t docker.lib.umd.edu/library-monitors:VERSION --push
```

### Pages

This service exposes the following URLs for monitor display:

Combined Displays:

*
*

Legacy Workstation Displays:

*
*

Legacy Equipment Displays:

*
*

### API Endpoints

The combined displays are dependent on the following JSON endpoints:

*
*
*
*

Root endpoint (just returns `{status: ok}` to all requests):

/ping endpoint (just returns `{status: ok}` to all requests):