Skip to content

Huly Network #9572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ on:
env:
CacheFolders: |
communication
network
common
desktop
desktop-package
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,25 @@ If you want to interact with Huly programmatically, check out our [API Client](.

You can find API usage examples in the [Huly examples](https://github.com/hcengineering/huly-examples) repository.

## Huly Virtual Network

The platform features a distributed network architecture that enables scalable, fault-tolerant communication between accounts, workspaces, and nodes. The [Huly Virtual Network](./network/README.md) provides:

- **Distributed Load Balancing**: Intelligent routing across multiple nodes using consistent hashing
- **Multi-Tenant Architecture**: Secure workspace isolation with role-based access control
- **Fault Tolerance**: Automatic failover and recovery mechanisms
- **Real-time Communication**: Event-driven architecture with broadcast capabilities

For detailed information about the network architecture, deployment, and API reference, see the [Network Documentation](./network/README.md).

## Table of Contents

- [Huly Platform](#huly-platform)
- [About](#about)
- [Self-Hosting](#self-hosting)
- [Activity](#activity)
- [API Client](#api-client)
- [Huly Virtual Network](#huly-virtual-network)
- [Table of Contents](#table-of-contents)
- [Pre-requisites](#pre-requisites)
- [Verification](#verification)
Expand Down Expand Up @@ -106,20 +118,21 @@ This project uses GitHub Packages for dependency management. To successfully dow
Follow these steps:

1. Generate a GitHub Token:

- Log in to your GitHub account
- Go to **Settings** > **Developer settings** > **Personal access tokens** (https://github.com/settings/personal-access-tokens)
- Click **Generate new token**
- Select the required scopes (at least `read:packages`)
- Generate the token and copy it

2. Authenticate with npm:

```bash
npm login --registry=https://npm.pkg.github.com
```

When prompted, enter your GitHub username, use the generated token as your password


## Fast start

```bash
Expand Down Expand Up @@ -280,6 +293,7 @@ This guide describes the nuances of building and running the application from so
#### Disk Space Requirements

Ensure you have sufficient disk space available:

- A fully deployed local application in clean Docker will consume slightly more than **35 GB** of WSL virtual disk space
- The application folder after build (sources + artifacts) will occupy **4.5 GB**

Expand All @@ -303,6 +317,7 @@ Make sure Docker is accessible from WSL:
Windows Git often automatically replaces line endings. Since most build scripts are `.sh` files, ensure your Windows checkout doesn't break them.

**Solution options:**

- Checkout from WSL instead of Windows
- Configure Git on Windows to disable auto-replacement:
```bash
Expand Down Expand Up @@ -343,6 +358,7 @@ After these preparations, the build instructions should work without issues.
When starting the application (`rush docker:up`), some network ports in Windows might be occupied. You can fix port mapping in the `\dev\docker-compose.yaml` file.

**Important:** Depending on which port you change, you'll need to:

1. Find what's using that port
2. Update the new address in the corresponding service configuration

Expand Down
94 changes: 94 additions & 0 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading