Quick Start - YtFlow/YtFlowApp GitHub Wiki

To begin with, you will need at least one proxy server in the form of URIs, such as ss://... or trojan://.... Usually these are provided by paid services. You may also want to self-host a proxy server, which is out of this wiki's scope. The protocol combos for the proxy servers might not be fully supported by YtFlowCore, hence you are recommended to read through YtFlowBook and find out available protocol/transport/obfs/tls plugins and their parameters like cipher for Shadowsocks.

Note YtFlow does not host or provide any proxy servers.

Install YtFlow

Go to YtFlow releases page, find a latest prerelease of YtFlowApp (next). In the Assets section, there should be an app package with name like 56263bdbai.YtFlow_x.y.z.0.AppxBundle. Download the app package, open and click Install.

Configure VPN connection

A one-time set up is required before YtFlow can start a connection. Go to System Settings app > Network & Internet > VPN, create a new VPN connection with:

  • VPN Provider: YtFlow
  • Connection Name: YtFlow Auto
  • Server name or address: https://github.com/YtFlow

and other fields with default values. VPN connection parameters screenshot

Click Save. The VPN connection entry will be used to control the lifecycle of YtFlowCore.

Configure profile

A profile defines how YtFlowCore works under the hood. It allows for various customizations like fake-ip/redir-host DNS, traffic routing (WIP), dynamic selection and outbound selection etc. Read more about YtFlow profiles at YtFlowBook.

Don't worry if you are not familiar with YtFlow or networking. Simply enter a name for the new profile and keep other options default. YtFlow create profile screenshot Click Create. The new profile will have a fake-ip DNS server and full IPv6 functionality. It will hijack fake IP requests and common Internet services such as Telegram.

Now that the profile is set up, we can connect using it right away. However, we have not imported any proxy servers yet, hence the outbound selector does not know how to establish an outbound connection.

Import proxy servers

Go to Asset page, click Create in Proxy Group section. Enter a group name and click Rename.

Note The proxy groups in YtFlow are literally groups of proxies. Advanced selection features like latency test, url-test or failover are covered by plugins (WIP) in the profile.

YtFlow rename proxy group screenshot

Go to the new proxy group, click Add. Paste URIs of your proxy servers at the input box. Click Import.

YtFlow import proxies screenshot

From the proxy list, you should see the names of the imported proxies.

Select proxy

Go back to Home page, click Connect beside the profile we have created just now.

YtFlow Connected

Inside outbound section, you can see which proxy server is currently selected. Click Select...

YtFlow outbound selection

You will see the imported proxy servers in the list. Click the one you want to select.