{"id":26334946,"url":"https://github.com/nasriyasoftware/orchestriq","last_synced_at":"2025-03-16T00:33:19.519Z","repository":{"id":280337346,"uuid":"907833770","full_name":"nasriyasoftware/Orchestriq","owner":"nasriyasoftware","description":"Orchestriq is a TypeScript library for programmatically managing Docker containers, images, networks, and volumes—both locally and remotely.","archived":false,"fork":false,"pushed_at":"2025-03-02T20:46:13.000Z","size":225,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T20:51:14.190Z","etag":null,"topics":["automation","container-management","devops","docker","docker-api","docker-daemon","infrastructure","orchestration","remote-docker"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@nasriya/orchestriq","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nasriyasoftware.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-24T14:00:09.000Z","updated_at":"2025-03-02T20:47:29.000Z","dependencies_parsed_at":"2025-03-02T20:51:16.748Z","dependency_job_id":"91f6faec-4dd9-4c64-99d7-6382587f2d6d","html_url":"https://github.com/nasriyasoftware/Orchestriq","commit_stats":null,"previous_names":["nasriyasoftware/orchestriq"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nasriyasoftware%2FOrchestriq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nasriyasoftware%2FOrchestriq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nasriyasoftware%2FOrchestriq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nasriyasoftware%2FOrchestriq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nasriyasoftware","download_url":"https://codeload.github.com/nasriyasoftware/Orchestriq/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809865,"owners_count":20351403,"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":["automation","container-management","devops","docker","docker-api","docker-daemon","infrastructure","orchestration","remote-docker"],"created_at":"2025-03-16T00:30:54.886Z","updated_at":"2025-03-16T00:33:19.512Z","avatar_url":"https://github.com/nasriyasoftware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![N|Solid](https://static.wixstatic.com/media/72ffe6_da8d2142d49c42b29c96ba80c8a91a6c~mv2.png)](https://nasriya.net)\n\n# Orchestriq.\n[![Static Badge](https://img.shields.io/badge/license-Free_(Restricted)-blue)](https://github.com/nasriyasoftware/Orchestriq?tab=License-1-ov-file) ![Repository Size](https://img.shields.io/github/repo-size/nasriyasoftware/Orchestriq.svg) ![Last Commit](https://img.shields.io/github/last-commit/nasriyasoftware/Orchestriq.svg) [![Status](https://img.shields.io/badge/Status-Stable-green.svg)](link-to-your-status-page)\n\n##### Visit us at [www.nasriya.net](https://nasriya.net).\n\nMade with ❤️ in **Palestine** 🇵🇸\n___\n#### Overview\nOrchestriq is a TypeScript library designed for seamless Docker management via code. It provides a high-level API to interact with containers, images, networks, and volumes, supporting both local Docker daemons and remote Docker hosts over the internet. With a clean and efficient design, Orchestriq simplifies automation, orchestration, and containerized application management.\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e 🌟 **Support Our Open-Source Development!** 🌟\n\u003e We need your support to keep our projects going! If you find our work valuable, please consider contributing. Your support helps us continue to develop and maintain these tools.\n\u003e \n\u003e **[Click here to support us!](https://fund.nasriya.net/)**\n\u003e \n\u003e Every contribution, big or small, makes a difference. Thank you for your generosity and support!\n___\n### Installation\n```shell\nnpm i @nasriya/orchestriq\n```\n\n### Importing\nImport in **ES6** module\n```ts\nimport orchestriq from '@nasriya/orchestriq';\n```\n\nImport in **CommonJS (CJS)**\n```js\nconst orchestriq = require('@nasriya/orchestriq').default;\n```\n___\n\n### Connect to Docker\n\nConnect to Docker running locally on the current machine:\n```js\nconst docker = new orchestriq.Docker();\n```\n\nIf you need to set the socket path:\n```js\nconst docker = new orchestriq.Docker({\n    hostType: 'local',\n    socketPath: '/var/run/docker.sock'\n});\n```\n\nConnect to remotely to the Docker daemon's socket:\n```js\nconst docker = new orchestriq.Docker({\n    hostType: 'remote',\n    /**The URL of the Docker daemon to connect to. */\n    host: 'https://daemon.nasriya.net/',\n    /**If authentication is required (as it should be), provide the nessary credentials here. */\n    authentication: {\n        type: 'Basic',\n        username: process.env.DOCKER_DAEMON_USERNAME,\n        password: process.env.DOCKER_DAEMON_PASSWORD\n    }\n});\n```\n**Note:** If you decided to expose the daemon APIs on the internet, you should setup authentications and access list to protect your the Docker APIs from unauthorized access.\n\n___\nWanna learn more? [Checkout our Wiki](https://github.com/nasriyasoftware/Orchestriq/wiki).\n\n___\n## License\nPlease read the license from [here](https://github.com/nasriyasoftware/Orchestriq?tab=License-1-ov-file).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasriyasoftware%2Forchestriq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnasriyasoftware%2Forchestriq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasriyasoftware%2Forchestriq/lists"}