Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (46 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 3.46 KB
Raw

Before Anything Else...

We are looking for contributors for this project. Please send email to hiddify@gmail.com To set up a development server, see DEVELOPMENT.md (clone into /opt/hiddify-manager with its submodule, make build, open it in VS Code). Basic tutorial on how to contibute to HiddifyManager is here

We need several type of helps:

  • Introducing our panel (we don't have any big media 😦)
  • Python developer
  • Rust developer (We do not want an high level rust developer. We just want to have someone who is familiar with rust and java script for a one day task)
  • Kotlin developer
  • Content providers
  • Services (for buying)

If you can help us, please dont hesitate to contact us at hiddify@gmail.com

Hiddify-Manager Directory Structure

/common/

This directory contains commonly used scripts for various tasks such as project installation, daily operations, firewall rule management, and more. These scripts provide essential functionality across different components of the project.

/haproxy/

This directory contains installation/initialization/configuration scripts of the HAProxy project.

The Hiddify utilizes HAProxy as its primary traffic load balancer and routing tool.

There are several Jinja2 (.j2) files, which are HAProxy configuration files. These files are used based on the panel configuration settings.

Certificates

The panel issues the domains' certificates itself (Let's Encrypt, then ZeroSSL) and keeps them in its database (hiddifypanel/acme); HAProxy answers the ACME challenges. nginx and acme.sh are deprecated (services/deprecated/).

/xray/

This directory contains installation/initialization scripts of the Xray-core.

The configs directory contains Xray's config files, which are Jinja2 (.j2) files. These config files are dynamically generated based on the panel configurations.

/singbox/

This direcotry contails installation/initialization scripts of the Sing-box.

The configs directory contains Sing-box's config files, which are Jinja2 (.j2) files. These config files are dynamically generated based on the panel configurations.

/hiddify-panel/

This directory contains installation scripts of the Hiddify Panel.

/other/

This directory contains some scripts for installing and initialization other tools that the Hiddify needs:

├── deprecated             # Deprecated tools
├── hiddify-cli            # A tool for checking proxy status on the server itself
├── mysql                  # MySQL installation/initialization scripts (Project database)
├── redis                  # Redis installation/initialization scripts (Project cache database)
├── speedtest              # Speedtest-related files
├── ssfaketls              # Shadowsocks faketls (obfs-server)
├── ssh                    # SSH proxy management installation/initialization scripts (ssh-liberty)
├── telegram               # Telegram mtproto installation/initialization scripts
├── v2ray                  # V2ray shadowsocks installation/initialization scripts (deprecated)
├── warp                   # Warp installation/initialization scripts
└── wireguard              # WireGuard installation/initialization scripts