Skip to content

Latest commit

 

History

History
94 lines (73 loc) · 4.95 KB

README.md

File metadata and controls

94 lines (73 loc) · 4.95 KB
Raw

Maple

A lightweight Universal Windows proxy app based on https://github.com/eycorsican/leaf

Features

  • Comes with Leaf core:
    • Domain name resolution with built-in DNS processor
    • tun/shadowsocks/socks/trojan/ws chainable inbounds
    • direct/drop/tls/ws/h2/shadowsocks/obfs/vmess/trojan/socks chainable outbounds
    • failover/tryall/static composed outbounds
    • amux multiplexing
    • Rule system based on IP, GeoIP and domain name
    • External rules from GeoIP database and V2Ray Domain List Community
  • Configuration management
  • Monaco-based conf editor with IntelliSence support
  • Outbound network adapter selection
  • UWP VPN Platform as TUN provider

Screenshots

Settings Page with IntelliSense demo

Getting Started

Maple as a UWP app is distributed for sideloading only. When installed, it acts as a VPN provider which you will find in the VPN Settings. Use Maple app for configuration management, as well as adding external databases.

Install

  1. Grab the latest package from Release page.
  2. Extract everything from the package.
  3. Right click the certificate (named Maple.App_x.y.z.0_x64.cer) and select Install Certificate.
  4. On the Certificate Import Wizard, select Local Machine. Administrator privileges may be required to proceed.
  5. Import the certificate to the Trusted Root Certification Authorities folder. Note: failure to import the certificate or choosing a wrong certificate store will prevent you from installing the app.
  6. Open the AppxBundle (named Maple.App_x.y.z.0_x64.appxbundle) and follow the instructions until Maple is successfully installed on your computer.

Set up

  1. Launch Maple from the Start menu.
  2. Edit configuration. Refer to https://github.com/eycorsican/leaf/blob/master/README.zh.md for further explanation.
  3. Save the configuration file.
  4. If any EXTERNAL or GEOIP directive is used, drag external database files into Config area. V2Ray Domain List Community database can be fetched at https://github.com/v2ray/domain-list-community/releases/latest/download/dlc.dat . For GeoIP database, please go to MaxMind Developer Portal and sign up for free download.
  5. Rename these databases accordingly (if applicable). By default, GeoIP database is geo.mmdb and V2Ray Domain List Community database is site.dat.
  6. Go to Setting page in Maple. Choose your network adapter such as Ethernet or WLAN.
  7. Launch Windows Settings app.
  8. Add a VPN connection.
  9. If any Proxy Server has a loopback address (127.0.0.1 or ::1), make sure Loopback Exemption is enabled for Maple. See https://docs.microsoft.com/en-us/previous-versions/windows/apps/hh770532(v=win.10) .

Connect

  • Simply click the toggle button on the title bar, or
  • In Windows 11, select the battery, network, or volume icon to open the Quick Settings panel. Find Maple in VPN panel and connect, or
  • In Windows 10, select the Network icon on the taskbar, and click Maple. In Windows Settings app, select Maple, and then Connect.

Note: Modifying the current configuration file while VPN is connected will take effect immediately. Hot reloading may be removed in a future release.

TODO

  • VPN lifecycle management on Maple UI
  • Better editing experience
  • external entries
  • Custom configuration folder location
  • Log collection (currently logs are sent to Visual Studio Output window for debugging only)
  • Unsandboxed Leaf core (#29)
  • VPN On Demand
  • Configurable routing entries
  • IPv6 support

Build

To build Leaf and Maple, you will need:

  • a Rust nightly-x86_64-pc-windows-msvc toolchain
  • Windows 10 SDK 10.0.22621
  • Visual Studio 2022 with C++ Development Workflow
  • Node.js 19.x or higher

Build steps:

  1. Recursively clone this repository.
  2. Open a PowerShell Prompt.
  3. Change working directory to leaf.
  4. cargo build -p leaf-ffi -Z build-std=std,panic_abort --target x86_64-uwp-windows-msvc.
    For Release builds, use cargo build -p leaf-ffi -Z build-std=std,panic_abort --target x86_64-uwp-windows-msvc --release.
    See also https://github.com/eycorsican/leaf#build .
  5. Change working directory to Maple.App\MonacoEditor.
  6. Build Monaco editor and language support: npm install && npm run build.
  7. Open Maple.sln in Visual Studio.
  8. Build Solution.