Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dunderrrrrr/openmediavault-fastapi-docker
FastAPI for OpenMediaVault
https://github.com/dunderrrrrr/openmediavault-fastapi-docker
docker docker-compose fastapi omv openmediaframework openmediavault python
Last synced: 2 months ago
JSON representation
FastAPI for OpenMediaVault
- Host: GitHub
- URL: https://github.com/dunderrrrrr/openmediavault-fastapi-docker
- Owner: dunderrrrrr
- Created: 2021-09-03T09:21:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-10T17:25:21.000Z (over 3 years ago)
- Last Synced: 2023-08-20T14:37:27.070Z (over 1 year ago)
- Topics: docker, docker-compose, fastapi, omv, openmediaframework, openmediavault, python
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# FastAPI for OpenMediaVault - docker
This API is based on [orrpan/python-openmediavault](https://github.com/orrpan/python-openmediavault) and [tiangolo/fastapi](https://github.com/tiangolo/fastapi).
___
**ovm-fastapi** is an api connected to your existing [OpenMediaVault](https://www.openmediavault.org/) nas or server. With this api you will be able to read:
* Host - cpu load, memory etc.
* Volumes - size, status
* Disks - temps, smart-status
* Raids - devices, status
* Fans - temperature
* Temps - temperature
* Services - all enabled services
* Detailed data:
* Detailed storage
* Detailed host
___
### Installation
First clone the repo.
```
$ git clone [email protected]:dunderrrrrr/openmediavault-fastapi-docker.git
```
Make sure to change the environment variables in `docker-compose.yml` before you start the container.
To start the container with docker-compose:
```
$ docker-compose up -d
```
Your application will start on [http://yourhost:8000](http://yourhost:8000).
Docs and redoc can be fould at [http://yourhost:8000/redoc](http://yourhost:8000/redoc) and [http://yourhost:8000/docs](http://yourhost:8000/docs).
---
Or you can build it yourself and start the container manually:
```
$ docker build --tag openmediavault-fastapi .
[...]
$ docker run -d -p 8000:8000 openmediavault-fastapi
```
Or create a virtualenv and run uvicorn:
```
$ mkvirtualenv omv-fastapi
$ pip install -r requirements.txt
$ uvicorn main:app --reload --host 0.0.0.0 --port 8000
````
___
### Paths
```
{
"path":"/openapi.json",
"name":"openapi"
},
{
"path":"/docs",
"name":"swagger_ui_html"
},
{
"path":"/docs/oauth2-redirect",
"name":"swagger_ui_redirect"
},
{
"path":"/redoc",
"name":"redoc_html"
},
{
"path":"/",
"name":"main"
},
{
"path":"/host",
"name":"host"
},
{
"path":"/volumes",
"name":"volumes"
},
{
"path":"/disks",
"name":"disks"
},
{
"path":"/raids",
"name":"raids"
},
{
"path":"/fans",
"name":"fans"
},
{
"path":"/temps",
"name":"temps"
},
{
"path":"/services",
"name":"services"
},
{
"path":"/detailed_storage",
"name":"volumes"
},
{
"path":"/detailed_host",
"name":"volumes"
}
```