Skip to content

Latest commit

 

History

History
178 lines (122 loc) · 6.04 KB

UIAndUsage.md

File metadata and controls

178 lines (122 loc) · 6.04 KB

User Interface

Home Page

Home Page

Local Group and Nodes

  • Create Local Group

Create local group

Enter the group name and you can pre-fill the node list in base64 format here, or leave it blank.

  • Edit Local Group

Right Click on the group item card and toggle the Edit action.

Edit group

Subscription Group

  • Create Subscription Group

Create Subscription group

The subscription content type should be one of the following three: Base64, SIP008, and JSON Outbound. If you are not sure, enter the subscription link in your browser to compare with the following scheme.

Subscription Type

  • Base64: Typically, it looks like vmess:// | ss:// | trojan://

    • VMESS: vmess://<base64EncodeJson>
    {
  "v": "2",
  "ps": "Names",
  "add": "111.111.111.111",
  "port": "32000",
  "id": "1386f85e-657b-4d6e-9d56-78badb75e1fd",
  "aid": "100",
  "scy": "zero",
  "net": "tcp",
  "type": "none",
  "host": "www.bbb.com",
  "path": "/",
  "tls": "tls",
  "sni": "www.ccc.com"
}

    • Shadowsocks SIP002: ss://<websafe-base64-encode-utf8(method:password)>@hostname:port/?plugin"#"tag

    • Trojan: trojan://<password>@<host>:<port>?sni=<server_name>&allowinsecure=<allow_insecure>&alpn=h2%0Ahttp/1.1#<name>

  • Shadowsocks SIP008:

    {
  "version": 1,
  "servers": [
    {
      // Server UUID to distinguish between servers when updating.
      "id": "27b8a625-4f4b-4428-9f0f-8a2317db7c79",
      "remarks": "Name of the server",
      "server": "example.com",
      "server_port": 8388,
      "password": "example",
      "method": "chacha20-ietf-poly1305",
      "plugin": "xxx",
      "plugin_opts": "xxxxx"
    },
    // Another server
    {
      "id": "7842c068-c667-41f2-8f7d-04feece3cb67",
      "remarks": "Name of the server",
      "server": "example.com",
      "server_port": 8388,
      "password": "example",
      "method": "chacha20-ietf-poly1305",
      "plugin": "xxx",
      "plugin_opts": "xxxxx"
    }
  ],
  // The above fields are mandatory.
  // Optional fields for data usage:
  "bytes_used": 274877906944,
  "bytes_remaining": 824633720832
  // You may add other custom fields in the root object.
}

  • VMESS Outbound Object

    {
  "sendThrough": "0.0.0.0",
  "protocol": "protocol name",
  "settings": {},
  "tag": "PROXY",
  "streamSettings": {},
  "proxySettings": {
    "tag": "another-outbound-tag",
    "transportLayer": false
  }
}

Update

When the application launches, it will automatically update the subscription groups according to the last updated time and update intervals.

For manual updates, you can right-click to update a single group or drop-down group list to update all groups.

update groups

Setting Page

setting page

All setting are in the configuration file, the default configuration file path is as follows:

  • UNIX: ~/.config/ACross/across.json
  • Windows: C:\Users\<UserName>\AppData\Local\ACross\across.json

You can also set it by the ACROSS_CONFIG_PATH environment variable.

Core Settings

Install

Before we connect to the nodes, we need to install and configure the core.

It's recommended to install the core via preferred package manager. As for other methods, you can refer to the official tutorial and make sure that there is no config.json file in your installation directory. More...

https://www.v2fly.org/guide/install.html

Select

core settings

  • Core Path: the path of your executable file - v2ray / v2ray.exe
  • Assets Path: File directory containing geoip.dat and geosite.dat

If the core is found as expected, the core information will be displayed in "Core info".

Also, before you test the API, you should start the proxy node by double-clicking the item card on the HomePage.

Inbound Settings

inbound settings

Currently, we do not provide any form of a global or transparent proxy, which means you need the set the environment variables or software built-in proxy client, such as Telegram Desktop and your browser, to the correct listening port. These ports should not be occupied by other applications. More...

Application Settings

application settings

  • The Data directory contains the database for storing node information and log files (if you set the Log Outputs to file or both stdout and file).

  • The User Agent is set to disguise the download behavior of the browser for curl downloader. If you don't know what it means, please leave it blank by default.

  • Auto Connect will automatically start the proxy when the app starts, if you don't have any available nodes, please don't open this option yet.

  • Auto Export will automatically export the current node configuration to data directory when you double-click the node item card.

  • Tray Icon requires the system tray. or GNOME users, we recommend installing an appindicator extensions and switch on gnome tweaks.

  • Minimize Startup allows you to start the application in background, usually enabled along with Auto Connect to make for quiet proxy. If you don't have the system tray, click the application icon again to show the main window.

Appearance Settings

appearance settings

Some options for setting the appearance, you can add a background image for yourself, or manually set the color schemes in the configuration file.