# AyBorg

**Repository Path**: witsbin/AyBorg

## Basic Information

- **Project Name**: AyBorg
- **Description**: AyBorg是一个高度可扩展的应用程序，旨在自动化各种任务。凭借其灵活的架构，AyBorg可以适应特定需求，并轻松与其他系统集成，使使其成为一个功能强大的自动化解决方案

- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-18
- **Last Updated**: 2025-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AyBorg

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Source-Alchemists_AyBorg&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Source-Alchemists_AyBorg)

:star:  We appreciate your star, it helps!

![Title](docs/img/title.png)

With AyBorg you have the power to build and customise your own automation applications without writing a single line of code. Just drag and drop elements, connect the ports and voila!

![Workflow](docs/img/workflow.gif)

Our platform focuses on computer vision, making it easier for you to keep an eye on your automation process.

We offer seamless integration with third-party plug-ins, so you can add custom functionality.

With our built-in auditing functionality, you'll have more control over your processes and data, leading to improved efficiency.

## Agents

AyBorg's **Agents** are specially designed services for automating processes. Using the **AyBorg.Gateway**, they can communicate with other areas of the application. These powerful tools are ideal for optimizing your workflow and can help increase your efficiency.

### Editor

Our editor makes it a breeze to program your own workflows using simple drag and drop of steps/plugins into the data flow.

![Agent editor](docs/img/agent-editor-comb.png)

## Getting started

### Git clone

`git clone https://github.com/Source-Alchemists/AyBorg.git --recursive` \
`cd AyBorg`

### Docker compose

We provide a ready to use Docker compose setup.

Just run `docker compose up` from the repository root directory. \
You can then open AyBorg at `https://localhost:6011`.

### (Optional) Manually

Because AyBorg is orchastrated into multipe services, you need to start each service separately.
In most cases the following setup makes sense:

1. A MQTT broker (e.g. [Eclipse-Mosquitto](https://mosquitto.org))
2. AyBorg.Gateway
3. AyBorg.Log
4. AyBorg.Web
5. One or more [AyBorg.Agent(s)](docs/agent/agent.md)

### Default credentials

The default appsettings give you a good starting point and will also work locally, but for real scenarios, you will need to change the settings.

> AyBorg default user "**SystemAdmin**" with password "**SystemAdmin123!**". \
> :warning: **The default password should be changed immediately!**

### Default Ports

| Service          | HTTP | HTTPS | gRPC |
| ---------------- | ---- | ----- | ---- |
| AyBorg.Gateway   |      |       | 6000 |
| AyBorg.Log       |      |       | 6001 |
| AyBorg.Web       | 6010 | 6011  |      |
| AyBorg.Agent     |      |       | 6020 |

## Want to contribute?

We are happy to accept contributions from the community. Please read our [contributing guidelines](CONTRIBUTING.md) for more information.

## License

AyBorg offers two licensing options to cover different use cases:

AGPL-3.0 License: This [OSI-approved](https://opensource.org/licenses/) open source license is ideal for students and enthusiasts, and encourages open collaboration and knowledge sharing. See the LICENSE file for more details.

Enterprise License: Designed for commercial use, this license allows seamless integration of AyBorg into commercial goods and services, bypassing the open source requirements of AGPL-3.0. If your scenario involves embedding our solutions into a commercial offering, please contact AyBorg Licensing.

**Note:** AyBorg.SDK operates under the MIT license, which allows plugin developers to create proprietary plugins. This gives developers the flexibility to build without open source restrictions. See the docs/license/MIT-license.txt for detailed information.