{"id":18020869,"url":"https://github.com/rm3l/docker-api-graphql","last_synced_at":"2025-03-26T21:32:36.673Z","repository":{"id":23681312,"uuid":"99454135","full_name":"rm3l/docker-api-graphql","owner":"rm3l","description":"GraphQL API wrapper around the Docker Remote API. SpringBoot-based app, written in Kotlin","archived":false,"fork":false,"pushed_at":"2025-03-22T04:36:48.000Z","size":1276,"stargazers_count":13,"open_issues_count":4,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-22T14:21:59.650Z","etag":null,"topics":["graphql","graphql-server","kotlin","spring-boot","springboot","springframework"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rm3l.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2017-08-05T23:57:31.000Z","updated_at":"2025-01-11T11:43:15.000Z","dependencies_parsed_at":"2023-02-18T19:45:40.130Z","dependency_job_id":"cc85cc49-4a88-412a-bd2a-e1a38c6a2406","html_url":"https://github.com/rm3l/docker-api-graphql","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rm3l%2Fdocker-api-graphql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rm3l%2Fdocker-api-graphql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rm3l%2Fdocker-api-graphql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rm3l%2Fdocker-api-graphql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rm3l","download_url":"https://codeload.github.com/rm3l/docker-api-graphql/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245739014,"owners_count":20664382,"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":["graphql","graphql-server","kotlin","spring-boot","springboot","springframework"],"created_at":"2024-10-30T06:08:06.651Z","updated_at":"2025-03-26T21:32:31.645Z","avatar_url":"https://github.com/rm3l.png","language":"Kotlin","readme":"# Docker API GraphQL\n\n[![Demo Video](https://raw.githubusercontent.com/rm3l/docker-api-graphql/master/assets/docker-api-graphql.png)](https://github.com/rm3l/docker-api-graphql \"docker-api-graphql\")\n\n\u003e A GraphQL API Server around the Docker Remote API. SpringBoot-based app, written in Kotlin.\n\n[![Build Workflow](https://github.com/rm3l/docker-api-graphql/workflows/CI/badge.svg)](https://github.com/rm3l/docker-api-graphql/actions?query=workflow%3A%22CI%22) \n[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/rm3l/docker-api-graphql/blob/master/LICENSE)\n[![Coverage Status](https://coveralls.io/repos/github/rm3l/docker-api-graphql/badge.svg?branch=master)](https://coveralls.io/github/rm3l/docker-api-graphql?branch=master)  \n\n\u003c!-- [![Docker Automated build](https://img.shields.io/docker/automated/rm3l/docker-api-graphql.svg)](https://hub.docker.com/r/rm3l/docker-api-graphql)  --\u003e\n\u003c!-- [![Docker Build Status](https://img.shields.io/docker/build/rm3l/docker-api-graphql.svg)](https://hub.docker.com/r/rm3l/docker-api-graphql)  --\u003e\n[![Docker Stars](https://img.shields.io/docker/stars/rm3l/docker-api-graphql.svg)](https://hub.docker.com/r/rm3l/docker-api-graphql) \n[![Docker Pulls](https://img.shields.io/docker/pulls/rm3l/docker-api-graphql.svg)](https://hub.docker.com/r/rm3l/docker-api-graphql)\n\n---\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*\n\n- [Running with Docker](#running-with-docker)\n- [API Endpoints](#api-endpoints)\n  - [/graphiql](#graphiql)\n  - [/graphql](#graphql)\n- [Building from source](#building-from-source)\n- [Contributing and Improving docker-api-graphql!](#contributing-and-improving-docker-api-graphql)\n- [TODO](#todo)\n- [Open-Source Libraries and Tools](#open-source-libraries-and-tools)\n- [Developed by](#developed-by)\n- [LICENSE](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n[![Demo Video](https://raw.githubusercontent.com/rm3l/docker-api-graphql/master/assets/docker-api-graphql-video-screenshot.png)](https://youtu.be/iSmBXnNo6VQ \"Demo Video for Docker API GraphQL\")\n\n\n## Running with Docker\n\nThis app can run as a lightweight Docker container.\n\nTo use it against a local Docker daemon listening on a local Unix socket: \n```bash\ndocker run \\\n --name docker-api-graphql \\\n -d \\\n -p 8080:8080 \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n rm3l/docker-api-graphql\n```\n\n\u003cb\u003eNote\u003c/b\u003e: the `-v /var/run/docker.sock:/var/run/docker.sock` option can be used in Linux environments only.\n\nFor more sophisticated use cases of Docker daemons accessible over the network (and secured with client certificates):\n```bash\ndocker run \\\n --name docker-api-graphql \\\n -d \\\n -p 8080:8080 \\\n -e DOCKER_HOST=https://\u003chost\u003e:\u003cport\u003e \\\n -v /path/to/my/docker/folder/containing/my/certificates:/etc/docker \\\n rm3l/docker-api-graphql\n```\n\n\u003cb\u003eNote\u003c/b\u003e: the `/path/to/my/docker/folder/containing/my/certificates` must be mounted under `/etc/docker` inside the running container, and must follow the semantics behind [the DOCKER_CERT_PATH environment variable](https://docs.docker.com/articles/https/#client-modes)  \n\nYou'll just need to access the port 8080 of the Docker engine where `docker-api-graphql` is running using your browser. \n\nDeploying this API to manage a Swarm cluster is just as easy ! You can directly deploy it as a service in your Docker cluster:\n```bash\ndocker service create \\\n --name docker-api-graphql \\\n -d \\\n --publish 8080:8080 \\\n --constraint 'node.role == manager' \\\n --mount type=bind,src=//var/run/docker.sock,dst=/var/run/docker.sock \\\n rm3l/docker-api-graphql \\\n -H unix:///var/run/docker.sock\n```\n\n## API Endpoints\n\n### /graphiql\n\nThis gives you access to a GraphiQL application in your browser, so you can play with the GraphQL API\n\n### /graphql\n\nThis is the entrypoint for the GraphQL API.\n\n\n## Building from source\n\nYou can build `docker-api-graphql` in the same way as any Gradle project on Git.\n\nHowever, thanks to the [Gradle Wrapper](https://docs.gradle.org/3.3/userguide/gradle_wrapper.html) (cf. `gradlew` and `gradlew.bat` scripts), \nyou do not need to have Gradle installed on your machine.\n\n1. Clone the `docker-api-graphql` repository on your machine:\n```bash\ngit clone https://github.com/rm3l/docker-api-graphql \u0026\u0026 cd docker-api-graphql\n```\n2. Switch to the appropriate branch if needed with `git checkout ...`\n3. Execute a Gradle build in the directory containing the `build.gradle` file:\n```bash\n./gradlew build\n```\n4. You will find the WAR artifact under the `build/libs` directory.\n\n## Contributing and Improving docker-api-graphql!\n\nContributions and issue reporting are more than welcome. \nSo to help out, do feel free to fork this repo and open up a pull request. \nI'll review and merge your changes as quickly as possible.\n\nYou can use [GitHub issues](https://github.com/rm3l/docker-api-graphql/issues) to report bugs. \nHowever, please make sure your description is clear enough and has sufficient instructions \nto be able to reproduce the issue.\n\n[comment]: \u003c\u003e (See CONTRIBUTING.md for more on contributing to this Github project.)\n\n\n## TODO\n\n* [ ] Map other endpoints of the Docker Remote API, e.g,: Services, Secrets, Tasks, ...\n* [ ] GraphQL Mutations\n* [ ] GraphQL Subscriptions if possible, especially for Docker events\n* [ ] Authentication / Authorization\n\n\n## Open-Source Libraries and Tools\n\n* [Kotlin](https://kotlinlang.org/), by Jetbrains\n* [Spring Boot](https://projects.spring.io/spring-boot/)\n* [docker-client](https://github.com/spotify/docker-client), by Spotify\n* [graphql-java](https://github.com/graphql-java/graphql-java)\n\n\n## Developed by\n\n* Armel Soro\n  * [keybase.io/rm3l](https://keybase.io/rm3l)\n  * [rm3l.org](https://rm3l.org) - \u0026lt;apps+docker_api_graphql@rm3l.org\u0026gt; - [@rm3l](https://twitter.com/rm3l)\n  * [paypal.me/rm3l](https://paypal.me/rm3l)\n  * [coinbase.com/rm3l](https://www.coinbase.com/rm3l)\n\n\n## LICENSE\n\n    The MIT License (MIT)\n    \n    Copyright (c) 2017 Armel Soro\n    \n    Permission is hereby granted, free of charge, to any person obtaining a copy\n    of this software and associated documentation files (the \"Software\"), to deal\n    in the Software without restriction, including without limitation the rights\n    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n    copies of the Software, and to permit persons to whom the Software is\n    furnished to do so, subject to the following conditions:\n    \n    The above copyright notice and this permission notice shall be included in all\n    copies or substantial portions of the Software.\n    \n    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n    SOFTWARE.\n\n","funding_links":["https://paypal.me/rm3l"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frm3l%2Fdocker-api-graphql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frm3l%2Fdocker-api-graphql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frm3l%2Fdocker-api-graphql/lists"}