@nasriya/orchestriq

Orchestriq.

Visit us at www.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!

Every contribution, big or small, makes a difference. Thank you for your generosity and support!

---

Installation

npm i @nasriya/orchestriq

Importing

Import in ES6 module

import orchestriq from '@nasriya/orchestriq';

Import in CommonJS (CJS)

const orchestriq = require('@nasriya/orchestriq').default;

---

Connect to Docker

Connect to Docker running locally on the current machine:

const docker = new orchestriq.Docker();

If you need to set the socket path:

const docker = new orchestriq.Docker({
    hostType: 'local',
    socketPath: '/var/run/docker.sock'
});

Connect to remotely to the Docker daemon's socket:

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 necessary 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.

---

License

Please read the license from here.