https://github.com/nasriyasoftware/orchestriq
Orchestriq is a TypeScript library for programmatically managing Docker containers, images, networks, and volumes—both locally and remotely.
https://github.com/nasriyasoftware/orchestriq
automation container-management devops docker docker-api docker-daemon infrastructure orchestration remote-docker
Last synced: about 1 month ago
JSON representation
Orchestriq is a TypeScript library for programmatically managing Docker containers, images, networks, and volumes—both locally and remotely.
- Host: GitHub
- URL: https://github.com/nasriyasoftware/orchestriq
- Owner: nasriyasoftware
- License: other
- Created: 2024-12-24T14:00:09.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-02T20:46:13.000Z (about 2 months ago)
- Last Synced: 2025-03-02T20:51:14.190Z (about 2 months ago)
- Topics: automation, container-management, devops, docker, docker-api, docker-daemon, infrastructure, orchestration, remote-docker
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@nasriya/orchestriq
- Size: 220 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://nasriya.net)
# Orchestriq.
[-blue)](https://github.com/nasriyasoftware/Orchestriq?tab=License-1-ov-file)   [](link-to-your-status-page)
##### Visit us at [www.nasriya.net](https://nasriya.net).
Made with ❤️ in **Palestine** 🇵🇸
___
#### Overview
Orchestriq 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.
> [!IMPORTANT]
>
> 🌟 **Support Our Open-Source Development!** 🌟
> 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.
>
> **[Click here to support us!](https://fund.nasriya.net/)**
>
> Every contribution, big or small, makes a difference. Thank you for your generosity and support!
___
### Installation
```shell
npm i @nasriya/orchestriq
```
### Importing
Import in **ES6** module
```ts
import orchestriq from '@nasriya/orchestriq';
```
Import in **CommonJS (CJS)**
```js
const orchestriq = require('@nasriya/orchestriq').default;
```
___
### Connect to Docker
Connect to Docker running locally on the current machine:
```js
const docker = new orchestriq.Docker();
```
If you need to set the socket path:
```js
const docker = new orchestriq.Docker({
hostType: 'local',
socketPath: '/var/run/docker.sock'
});
```
Connect to remotely to the Docker daemon's socket:
```js
const docker = new orchestriq.Docker({
hostType: 'remote',
/**The URL of the Docker daemon to connect to. */
host: 'https://daemon.nasriya.net/',
/**If authentication is required (as it should be), provide the nessary credentials here. */
authentication: {
type: 'Basic',
username: process.env.DOCKER_DAEMON_USERNAME,
password: process.env.DOCKER_DAEMON_PASSWORD
}
});
```
**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.
___
Wanna learn more? [Checkout our Wiki](https://github.com/nasriyasoftware/Orchestriq/wiki).
___
## License
Please read the license from [here](https://github.com/nasriyasoftware/Orchestriq?tab=License-1-ov-file).