{"id":22191287,"url":"https://github.com/dunderrrrrr/openmediavault-fastapi-docker","last_synced_at":"2025-06-22T06:33:29.253Z","repository":{"id":189505199,"uuid":"402713815","full_name":"dunderrrrrr/openmediavault-fastapi-docker","owner":"dunderrrrrr","description":"FastAPI for OpenMediaVault","archived":false,"fork":false,"pushed_at":"2025-02-16T18:32:32.000Z","size":25,"stargazers_count":7,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T13:16:24.474Z","etag":null,"topics":["docker","docker-compose","fastapi","omv","openmediaframework","openmediavault","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dunderrrrrr.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-03T09:21:19.000Z","updated_at":"2024-05-18T08:24:20.000Z","dependencies_parsed_at":"2023-08-20T14:54:23.146Z","dependency_job_id":"23509f75-6702-40b5-a934-0753380180ce","html_url":"https://github.com/dunderrrrrr/openmediavault-fastapi-docker","commit_stats":null,"previous_names":["dunderrrrrr/openmediavault-fastapi-docker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dunderrrrrr/openmediavault-fastapi-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunderrrrrr%2Fopenmediavault-fastapi-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunderrrrrr%2Fopenmediavault-fastapi-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunderrrrrr%2Fopenmediavault-fastapi-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunderrrrrr%2Fopenmediavault-fastapi-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dunderrrrrr","download_url":"https://codeload.github.com/dunderrrrrr/openmediavault-fastapi-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunderrrrrr%2Fopenmediavault-fastapi-docker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261248434,"owners_count":23130392,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","fastapi","omv","openmediaframework","openmediavault","python"],"created_at":"2024-12-02T12:15:17.516Z","updated_at":"2025-06-22T06:33:24.241Z","avatar_url":"https://github.com/dunderrrrrr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FastAPI for OpenMediaVault - docker\r\n\r\n\r\nThis API is based on [orrpan/python-openmediavault](https://github.com/orrpan/python-openmediavault) and [tiangolo/fastapi](https://github.com/tiangolo/fastapi).\r\n\r\n\r\n![](https://i.imgur.com/NQytJ89.png)\r\n___\r\n\r\n**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:\r\n\r\n* Host - cpu load, memory etc.\r\n* Volumes - size, status\r\n* Disks - temps, smart-status\r\n* Raids - devices, status\r\n* Fans - temperature\r\n* Temps - temperature\r\n* Services - all enabled services\r\n\r\n* Detailed data:\r\n\t* Detailed storage\r\n\t* Detailed host\r\n___\r\n\r\n### Installation\r\n\r\nFirst clone the repo.\r\n```\r\n$ git clone git@github.com:dunderrrrrr/openmediavault-fastapi-docker.git\r\n```\r\n\r\nMake sure to change the environment variables in `docker-compose.yml` before you start the container.  \r\nTo start the container with docker-compose:\r\n```\r\n$ docker-compose up -d\r\n```\r\n\r\nYour application will start on [http://yourhost:8000](http://yourhost:8000).   \r\nDocs and redoc can be fould at [http://yourhost:8000/redoc](http://yourhost:8000/redoc) and [http://yourhost:8000/docs](http://yourhost:8000/docs).\r\n\r\n---\r\n\r\nOr you can build it yourself and start the container manually:\r\n```\r\n$ docker build --tag openmediavault-fastapi .\r\n[...]\r\n$ docker run -d -p 8000:8000 openmediavault-fastapi\r\n```\r\n\r\nOr create a virtualenv and run uvicorn:\r\n```\r\n$ mkvirtualenv omv-fastapi\r\n$ pip install -r requirements.txt\r\n$ uvicorn main:app --reload --host 0.0.0.0 --port 8000\r\n````\r\n\r\n___\r\n\r\n### Paths\r\n\r\n```\r\n{\r\n   \"path\":\"/openapi.json\",\r\n   \"name\":\"openapi\"\r\n},\r\n{\r\n   \"path\":\"/docs\",\r\n   \"name\":\"swagger_ui_html\"\r\n},\r\n{\r\n   \"path\":\"/docs/oauth2-redirect\",\r\n   \"name\":\"swagger_ui_redirect\"\r\n},\r\n{\r\n   \"path\":\"/redoc\",\r\n   \"name\":\"redoc_html\"\r\n},\r\n{\r\n   \"path\":\"/\",\r\n   \"name\":\"main\"\r\n},\r\n{\r\n   \"path\":\"/host\",\r\n   \"name\":\"host\"\r\n},\r\n{\r\n   \"path\":\"/volumes\",\r\n   \"name\":\"volumes\"\r\n},\r\n{\r\n   \"path\":\"/disks\",\r\n   \"name\":\"disks\"\r\n},\r\n{\r\n   \"path\":\"/raids\",\r\n   \"name\":\"raids\"\r\n},\r\n{\r\n   \"path\":\"/fans\",\r\n   \"name\":\"fans\"\r\n},\r\n{\r\n   \"path\":\"/temps\",\r\n   \"name\":\"temps\"\r\n},\r\n{\r\n   \"path\":\"/services\",\r\n   \"name\":\"services\"\r\n},\r\n{\r\n   \"path\":\"/detailed_storage\",\r\n   \"name\":\"volumes\"\r\n},\r\n{\r\n   \"path\":\"/detailed_host\",\r\n   \"name\":\"volumes\"\r\n}\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdunderrrrrr%2Fopenmediavault-fastapi-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdunderrrrrr%2Fopenmediavault-fastapi-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdunderrrrrr%2Fopenmediavault-fastapi-docker/lists"}