{"id":20681202,"url":"https://github.com/xrayr-project/xrayr-release","last_synced_at":"2025-04-05T07:07:50.150Z","repository":{"id":50328546,"uuid":"486042619","full_name":"XrayR-project/XrayR-release","owner":"XrayR-project","description":"XrayR 一键脚本以及docker部署","archived":false,"fork":false,"pushed_at":"2024-08-07T13:31:12.000Z","size":3051,"stargazers_count":185,"open_issues_count":5,"forks_count":250,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T06:08:25.343Z","etag":null,"topics":["docker","shadowsocks","sspanel-uim","trojan","v2board","xrayr"],"latest_commit_sha":null,"homepage":"https://xrayr-project.github.io/XrayR-doc/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/XrayR-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-27T04:18:25.000Z","updated_at":"2025-03-19T12:23:33.000Z","dependencies_parsed_at":"2024-06-22T21:47:17.658Z","dependency_job_id":"f758bc35-14c4-45c2-b5bc-9c6b0999bfe4","html_url":"https://github.com/XrayR-project/XrayR-release","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XrayR-project%2FXrayR-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XrayR-project%2FXrayR-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XrayR-project%2FXrayR-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XrayR-project%2FXrayR-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XrayR-project","download_url":"https://codeload.github.com/XrayR-project/XrayR-release/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299833,"owners_count":20916190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","shadowsocks","sspanel-uim","trojan","v2board","xrayr"],"created_at":"2024-11-16T22:10:05.652Z","updated_at":"2025-04-05T07:07:50.133Z","avatar_url":"https://github.com/XrayR-project.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XRayR\nA Xray backend framework that can easily support many panels.\n\n一个基于Xray的后端框架，支持V2ay,Trojan,Shadowsocks协议，极易扩展，支持多面板对接\n\nFind the source code here: [XrayR-project/XrayR](https://github.com/XrayR-project/XrayR)\n\n# 详细使用教程\n\n[教程](https://xrayr-project.github.io/XrayR-doc/)\n\n# 一键安装\n\n```\nbash \u003c(curl -Ls https://raw.githubusercontent.com/XrayR-project/XrayR-release/master/install.sh)\n```\n# Docker 安装\n\n```\ndocker pull ghcr.io/xrayr-project/xrayr:latest \u0026\u0026 docker run --restart=always --name xrayr -d -v ${PATH_TO_CONFIG}/config.yml:/etc/XrayR/config.yml --network=host ghcr.io/xrayr-project/xrayr:latest\n```\n\n# Docker compose 安装\n0. 安装docker-compose: \n```\ncurl -fsSL https://get.docker.com | bash -s docker\ncurl -L \"https://github.com/docker/compose/releases/download/1.26.1/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\nchmod +x /usr/local/bin/docker-compose\n```\n1. `git clone https://github.com/XrayR-project/XrayR-release`\n2. `cd XrayR-release`\n3. 编辑config。\n配置文件基本格式如下，Nodes下可以同时添加多个面板，多个节点配置信息，只需添加相同格式的Nodes item即可。\n4. 启动docker：`docker-compose up -d`\n```\nLog:\n  Level: none # Log level: none, error, warning, info, debug \n  AccessPath: # /etc/XrayR/access.Log\n  ErrorPath: # /etc/XrayR/error.log\nDnsConfigPath: # /etc/XrayR/dns.json Path to dns config\nConnetionConfig:\n  Handshake: 4 # Handshake time limit, Second\n  ConnIdle: 10 # Connection idle time limit, Second\n  UplinkOnly: 2 # Time limit when the connection downstream is closed, Second\n  DownlinkOnly: 4 # Time limit when the connection is closed after the uplink is closed, Second\n  BufferSize: 64 # The internal cache size of each connection, kB \nNodes:\n  -\n    PanelType: \"SSpanel\" # Panel type: SSpanel, V2board, PMpanel\n    ApiConfig:\n      ApiHost: \"http://127.0.0.1:667\"\n      ApiKey: \"123\"\n      NodeID: 41\n      NodeType: V2ray # Node type: V2ray, Shadowsocks, Trojan\n      Timeout: 30 # Timeout for the api request\n      EnableVless: false # Enable Vless for V2ray Type\n      EnableXTLS: false # Enable XTLS for V2ray and Trojan\n      SpeedLimit: 0 # Mbps, Local settings will replace remote settings, 0 means disable\n      DeviceLimit: 0 # Local settings will replace remote settings, 0 means disable\n      RuleListPath: # /etc/XrayR/rulelist Path to local rulelist file\n    ControllerConfig:\n      ListenIP: 0.0.0.0 # IP address you want to listen\n      SendIP: 0.0.0.0 # IP address you want to send pacakage\n      UpdatePeriodic: 60 # Time to update the nodeinfo, how many sec.\n      EnableDNS: false # Use custom DNS config, Please ensure that you set the dns.json well\n      DNSType: AsIs # AsIs, UseIP, UseIPv4, UseIPv6, DNS strategy\n      EnableProxyProtocol: false # Only works for WebSocket and TCP\n      EnableFallback: false # Only support for Trojan and Vless\n      FallBackConfigs:  # Support multiple fallbacks\n        -\n          SNI: # TLS SNI(Server Name Indication), Empty for any\n          Path: # HTTP PATH, Empty for any\n          Dest: 80 # Required, Destination of fallback, check https://xtls.github.io/config/fallback/ for details.\n          ProxyProtocolVer: 0 # Send PROXY protocol version, 0 for dsable\n      CertConfig:\n        CertMode: dns # Option about how to get certificate: none, file, http, dns. Choose \"none\" will forcedly disable the tls config.\n        CertDomain: \"node1.test.com\" # Domain to cert\n        CertFile: /etc/XrayR/cert/node1.test.com.cert # Provided if the CertMode is file\n        KeyFile: /etc/XrayR/cert/node1.test.com.key\n        Provider: alidns # DNS cert provider, Get the full support list here: https://go-acme.github.io/lego/dns/\n        Email: test@me.com\n        DNSEnv: # DNS ENV option used by DNS provider\n          ALICLOUD_ACCESS_KEY: aaa\n          ALICLOUD_SECRET_KEY: bbb\n  # -\n  #   PanelType: \"V2board\" # Panel type: SSpanel, V2board\n  #   ApiConfig:\n  #     ApiHost: \"http://127.0.0.1:668\"\n  #     ApiKey: \"123\"\n  #     NodeID: 4\n  #     NodeType: Shadowsocks # Node type: V2ray, Shadowsocks, Trojan\n  #     Timeout: 30 # Timeout for the api request\n  #     EnableVless: false # Enable Vless for V2ray Type\n  #     EnableXTLS: false # Enable XTLS for V2ray and Trojan\n  #     SpeedLimit: 0 # Mbps, Local settings will replace remote settings\n  #     DeviceLimit: 0 # Local settings will replace remote settings\n  #   ControllerConfig:\n  #     ListenIP: 0.0.0.0 # IP address you want to listen\n  #     UpdatePeriodic: 10 # Time to update the nodeinfo, how many sec.\n  #     EnableDNS: false # Use custom DNS config, Please ensure that you set the dns.json well\n  #     CertConfig:\n  #       CertMode: dns # Option about how to get certificate: none, file, http, dns\n  #       CertDomain: \"node1.test.com\" # Domain to cert\n  #       CertFile: /etc/XrayR/cert/node1.test.com.cert # Provided if the CertMode is file\n  #       KeyFile: /etc/XrayR/cert/node1.test.com.pem\n  #       Provider: alidns # DNS cert provider, Get the full support list here: https://go-acme.github.io/lego/dns/\n  #       Email: test@me.com\n  #       DNSEnv: # DNS ENV option used by DNS provider\n  #         ALICLOUD_ACCESS_KEY: aaa\n  #         ALICLOUD_SECRET_KEY: bbb\n```\n\n## Docker compose升级\n在docker-compose.yml目录下执行：\n```\ndocker-compose pull\ndocker-compose up -d\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxrayr-project%2Fxrayr-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxrayr-project%2Fxrayr-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxrayr-project%2Fxrayr-release/lists"}