readme fix

Author: the2pizza

README.md

@@ -1,93 +1,72 @@
-[![Release](https://github.com/frkn-dev/pony/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/frkn-dev/pony/actions/workflows/release.yml) [![Pony Build](https://github.com/frkn-dev/pony/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/frkn-dev/pony/actions/workflows/rust.yml)
+[![Release](https://github.com/frkn-dev/fcore/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/frkn-dev/fcore/actions/workflows/release.yml) [![Fc0re Build](https://github.com/frkn-dev/pony/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/frkn-dev/fcore/actions/workflows/rust.yml)
 
-# Pony - a cluster platform for Xray/Shadowsocks/Hysteria2/Wireguard/MTproto
+# Fc0re - a cluster platform for Xray/Shadowsocks/Hysteria2/Wireguard/Amnezia-Wireguard/MTproto
 
-Pony is a lightweight control plane and orchestration platform for modern proxy protocols. It simplifies the deployment and unified management of Xray, Shadowsocks, Hysteria2, MTproto and Wireguard servers, providing a single pane of glass for your network infrastructure.
+Fc0re is a lightweight control plane and orchestration platform for modern proxy protocols.
+It simplifies the deployment and unified management of Xray, Shadowsocks, Hysteria2, MTproto, Wireguard and Amnezia-Wireguard servers,
+providing a single pane of glass for your network infrastructure.
 
 ## Architecture
 
 Contains parts
 
-- agent — manages Xray/Wireguard/Hysteria2 connections/users/metrics
-- api — manages cluster of servers, gets API calls and send commands to servers
-- auth — handles auth for Hysteri2 cleints 
-- utils — helper to work/debug Bin messages
+- node — manages Xray/Shadowsocks/Hysteria2/Wireguard/Amnezia-Wireguard/MTproto connections/users/metrics
+- api — manages cluster of servers, gets API calls and send commands to servers using ZeroMQ PUB/SUB mechanizme
+- auth — handles auth for Hysteri2 clients and trial API
 
 ### As dependencies the platfrom has
 
 - ZeroMQ — communicating bus
 - PostgreSQL — user and node data storage
 - Xray Core
 - Hysteria2
-- MTproto
+- Teleproxy (MTProxy)
 - Wireguard
+- Amnezia Wireguard
 - Nginx — reverse proxy
 
 ### Features
 
-- Standalone Agent — can run without external dependencies: just WG or/and Xray Core and a config file.
+- Standalone Node — can run without external dependencies.
 - Automatic Xray Config Parsing — reads xray-config.json to fetch inbounds and settings automatically.
-- Low Resource Usage — works perfectly on low-cost 1 CPU ($5 VPS) machines.
-- Protocol Support — handles VLESS TCP, VLESS gRPC, VLESS Xhttp, Hysteria2 and Wireguard connections.
+- Low Resource Usage — works perfectly on low-cost 1 CPU ($3 VPS) machines.
+- Protocol Support — handles VLESS TCP, VLESS gRPC, VLESS Xhttp, Hysteria2, Wireguard and Amnezia Wireguard connections.
 - Cluster Management — API manages users and nodes across the entire cluster.
 - Node Health Monitoring — API periodically checks the health and status of all connected nodes.
 - Metrics System — system and logic metrics are collected in Graphite format and stored in Clickhouse for analytics.
-- Trial User Support — supports trial users with daily traffic limitation control.
+- Trial User Support — supports trial users.
 
-# Utils — CLI Tool for Working with rkyv Messages and ZeroMQ
+## Getting Started
 
-## Overview
+### Prerequisites
 
-utils is a command-line utility to generate, verify, and send binary rkyv messages used in the messaging system over ZeroMQ. It helps to easily create valid messages from JSON, serialize them to binary files, and publish them on a ZeroMQ topic.
-Usage
+- **Rust** (nightly toolchain)
+- **PostgreSQL** 17+
+- **ZeroMQ** libraries installed on your system
+- **Protobuf Compiler** (`protoc`)
 
-Generate binary message from JSON
+### Installation & Build
 
-```
-cargo run --bin utils gen -i path/to/input.json -o path/to/output.bin
-
-    -i — path to the JSON file describing the message
+1. **Clone the repository:**
 
-    -o — path to save the generated binary file
-
-    The JSON must match the Message struct format.
+```bash
+git clone [https://github.com/frkn-dev/fcore.git](https://github.com/frkn-dev/fcore.git)
+cd fcore
 ```
 
-Send a binary message to ZeroMQ publisher
+2. **Build all components:**
 
+```bash
+cargo build --release
 ```
-cargo run --bin utils send -t topic -i path/to/message.bin -a tcp://127.0.0.1:3000
-
-    -t — topic (channel) to publish on
 
-    -i — path to the binary message file
+3. **Configuration**
 
-    -a — ZeroMQ publisher address
+```bash
+cp config-node-example.toml config-node.toml
+cp config-api-example.toml config-api.toml
 ```
 
-Combined mode: generate and send in one step
+## License
 
-    cargo run --bin utils all -i path/to/input.json -b path/to/output.bin -t topic -a tcp://127.0.0.1:3000`
-
-Generates binary from JSON, saves it, and immediately publishes it to the given topic and address.
-
-```
-Example JSON for Message
-
-{
-  "conn_id": "9658b391-01cb-4031-a3f5-6cbdd749bcff",
-  "action": "Create",
-  "tag": "Wireguard",
-  "wg": {
-    "keys": {
-      "privkey": "privatekeyhere",
-      "pubkey": "publickeyhere"
-    },
-    "address": {
-      "ip": "10.10.0.24",
-      "cidr": 32
-    }
-  },
-  "password": null
-}
-```
+This project is licensed under the MIT License - see the LICENSE file for details.

config-agent-example.toml config-node-example.tomlconfig-agent-example.toml renamed to config-node-example.toml

@@ -0,0 +1,10 @@
+
+
+requests.post(
+'http://127.0.0.1:3005/trial',
+headers={
+'Content-Type': 'application/json'
+},
+json={
+"email": "2pizza1063@gmail.com"
+})

dev/auth.request

@@ -205,6 +205,7 @@ where
                 Tag::VlessGrpcReality,
                 Tag::VlessTcpReality,
                 Tag::VlessXhttpReality,
+                Tag::Vmess,
             ];
 
             let xray_nodes = nodes.clone();

src/bin/api/http/handlers/subscription.rs

@@ -1,7 +1,7 @@
 use serde::Deserialize;
 use std::net::Ipv4Addr;
 
-use fcore::{ApiAccessConfig, MetricsTxConfig, NodeConfigRaw, Result, Settings};
+use fcore::{ApiAccessConfig, Env, MetricsTxConfig, NodeConfigRaw, Result, Settings, Tag};
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct ServiceSettings {
@@ -48,6 +48,9 @@ pub struct ServiceConfig {
     #[serde(default = "default_cors_origin")]
     pub origin: String,
     pub updates_endpoint_zmq: String,
+
+    pub enabled_envs: Vec<Env>,
+    pub enabled_protos: Vec<Tag>,
 }
 
 #[cfg(feature = "email")]

src/bin/auth/config.rs

@@ -1,4 +1,4 @@
-use fcore::ApiAccessConfig;
+use fcore::{ApiAccessConfig, Env, Tag};
 use warp::Filter;
 
 #[cfg(feature = "email")]
@@ -16,3 +16,15 @@ pub fn with_api_settings(
 ) -> impl Filter<Extract = (ApiAccessConfig,), Error = std::convert::Infallible> + Clone {
     warp::any().map(move || api.clone())
 }
+
+pub fn with_envs(
+    envs: Vec<Env>,
+) -> impl Filter<Extract = (Vec<Env>,), Error = std::convert::Infallible> + Clone {
+    warp::any().map(move || envs.clone())
+}
+
+pub fn with_protos(
+    protos: Vec<Tag>,
+) -> impl Filter<Extract = (Vec<Tag>,), Error = std::convert::Infallible> + Clone {
+    warp::any().map(move || protos.clone())
+}

src/bin/auth/filters.rs

@@ -4,6 +4,7 @@ use tokio::sync::RwLock;
 use fcore::{
     http::{helpers as http, response::Instance},
     ApiAccessConfig, ConnectionBaseOperations, ConnectionStorageBaseOperations, Connections, Env,
+    Tag,
 };
 
 #[cfg(feature = "email")]
@@ -14,12 +15,36 @@ use super::http::HttpClient;
 use super::request;
 use super::response;
 use super::service::DEFAULT_DAYS;
-use super::service::PROTOS;
+
+pub async fn auth_handler<C>(
+    req: request::Auth,
+    memory: Arc<RwLock<Connections<C>>>,
+) -> Result<impl warp::Reply, warp::Rejection>
+where
+    C: ConnectionBaseOperations + Sync + Send + Clone + 'static + std::fmt::Display,
+{
+    tracing::debug!("Auth req {} {} {}", req.auth, req.addr, req.tx);
+    let mem = memory.read().await;
+    if let Some(id) = mem.validate_token(&req.auth) {
+        Ok(warp::reply::json(&response::Auth {
+            ok: true,
+            id: Some(id.to_string()),
+        }))
+    } else {
+        Ok(warp::reply::json(&response::Auth {
+            ok: false,
+            id: None,
+        }))
+    }
+}
 
 pub async fn activate_key_handler(
     req: request::ActivateKey,
     http: HttpClient,
     api: ApiAccessConfig,
+
+    envs: Vec<Env>,
+    protos: Vec<Tag>,
 ) -> Result<impl warp::Reply, warp::Rejection> {
     let key = match validate_key(&http, &api.endpoint, &api.token, &req.code).await {
         Ok(k) => k,
@@ -45,7 +70,7 @@ pub async fn activate_key_handler(
                 Err(e) => return Ok(http::internal_error(&format!("Creation failed: {}", e))),
             };
 
-        if let Err(e) = setup_connections(&http, &api, &sub.id).await {
+        if let Err(e) = setup_connections(&http, &api, &sub.id, envs, protos).await {
             tracing::error!("{}", e);
             return Ok(http::internal_error("Failed to establish connections."));
         }
@@ -89,6 +114,8 @@ pub async fn trial_handler(
     store: EmailStore,
     http: HttpClient,
     api: ApiAccessConfig,
+    envs: Vec<Env>,
+    protos: Vec<Tag>,
 ) -> Result<impl warp::Reply, warp::Rejection> {
     if store.check_email_hmac(&req.email).await {
         return Ok(http::bad_request("Trial already requested"));
@@ -104,7 +131,7 @@ pub async fn trial_handler(
             }
         };
 
-    if let Err(e) = setup_connections(&http, &api, &sub.id).await {
+    if let Err(e) = setup_connections(&http, &api, &sub.id, envs, protos).await {
         tracing::error!("{}", e);
         return Ok(http::internal_error(
             "Failed to establish trial connections.",
@@ -134,6 +161,8 @@ pub async fn tg_trial_handler(
     req: request::TgTrial,
     http: HttpClient,
     api: ApiAccessConfig,
+    envs: Vec<Env>,
+    protos: Vec<Tag>,
 ) -> Result<impl warp::Reply, warp::Rejection> {
     let referred_by = req.referred_by.unwrap_or_else(|| "TG".to_string());
 
@@ -147,7 +176,7 @@ pub async fn tg_trial_handler(
         };
 
     // 2. Create connections
-    if let Err(e) = setup_connections(&http, &api, &sub.id).await {
+    if let Err(e) = setup_connections(&http, &api, &sub.id, envs, protos).await {
         tracing::error!("{}", e);
         return Ok(http::internal_error(
             "Failed to establish trial connections.",
@@ -161,36 +190,15 @@ pub async fn tg_trial_handler(
     ))
 }
 
-pub async fn auth_handler<C>(
-    req: request::Auth,
-    memory: Arc<RwLock<Connections<C>>>,
-) -> Result<impl warp::Reply, warp::Rejection>
-where
-    C: ConnectionBaseOperations + Sync + Send + Clone + 'static + std::fmt::Display,
-{
-    tracing::debug!("Auth req {} {} {}", req.auth, req.addr, req.tx);
-    let mem = memory.read().await;
-    if let Some(id) = mem.validate_token(&req.auth) {
-        Ok(warp::reply::json(&response::Auth {
-            ok: true,
-            id: Some(id.to_string()),
-        }))
-    } else {
-        Ok(warp::reply::json(&response::Auth {
-            ok: false,
-            id: None,
-        }))
-    }
-}
-
 async fn setup_connections(
     http: &HttpClient,
     api: &ApiAccessConfig,
     sub_id: &uuid::Uuid,
+    envs: Vec<Env>,
+    protos: Vec<Tag>,
 ) -> Result<(), String> {
-    let envs = [Env::Production, Env::Dev, Env::Ru, Env::Wl];
     let futures = envs.iter().flat_map(|env| {
-        PROTOS.iter().map(move |proto| {
+        protos.iter().map(move |proto| {
             create_connection(http, env, proto, sub_id, &api.endpoint, &api.token)
         })
     });

src/bin/auth/handlers.rs

@@ -2,7 +2,7 @@ use serde::Deserialize;
 
 use fcore::{
     http::response::{Instance, InstanceWithId, ResponseMessage, SubscriptionResponse},
-    Code, Env, Error, Key, Result, Subscription,
+    Code, Env, Error, Key, Result, Subscription, Tag,
 };
 
 use super::http::HttpClient;
@@ -170,7 +170,7 @@ pub async fn create_subscription(
 pub async fn create_connection(
     http: &HttpClient,
     env: &Env,
-    proto: &str,
+    proto: &Tag,
     sub_id: &uuid::Uuid,
     api_address: &str,
     api_token: &str,
@@ -180,7 +180,7 @@ pub async fn create_connection(
     let res = auth_headers(
         http.post(format!("{}/connection", api_address))
             .json(&serde_json::json!({
-                "env": env.to_string(),
+                "env": env,
                 "proto": proto,
                 "subscription_id": sub_id
             })),