README.md

   1 # v2raya-openwrt
   2
   3 opkg feed of v2rayA for OpenWrt users.
   4
   5 [简体中文](README.zh-cn.md)
   6
   7 ## How to install
   8
   9 1. Add v2rayA usign key
  10
  11    > Make sure package `wget-ssl` is installed on your device
  12
  13    ```sh
  14    wget https://osdn.net/projects/v2raya/storage/openwrt/v2raya.pub -O /etc/opkg/keys/94cc2a834fb0aa03
  15    ```
  16
  17 2. Import v2rayA feed
  18
  19    ```sh
  20    echo "src/gz v2raya https://osdn.net/projects/v2raya/storage/openwrt/$(. /etc/openwrt_release && echo "$DISTRIB_ARCH")" | tee -a "/etc/opkg/customfeeds.conf"
  21    ```
  22
  23 3. Update feeds
  24
  25    ```sh
  26    opkg update
  27    ```
  28
  29 4. Install v2rayA and its dependencies
  30
  31    ```sh
  32    opkg install v2raya
  33
  34    # Choose a core you'd like to use, v2ray or Xray
  35    # If you have both installed, the former is preferred by default
  36    #
  37    # Note from maintainer: due to broken tproxy support in v2ray, recommend using Xray instead
  38    opkg install xray-core
  39    # opkg install v2ray-core
  40
  41    # Optional
  42    # opkg install v2fly-geoip v2fly-geosite
  43    ```
  44
  45 ## How to use
  46
  47 - Method 1 - Configure via LuCI interface (for __OpenWrt 21.02 and higher__ version only)
  48
  49    1. Install LuCI app
  50
  51       ```sh
  52       opkg install luci-app-v2raya
  53       ```
  54
  55    2. Visit `http://<your_router_ip>/cgi-bin/luci/admin/services/v2raya` and complete setup.
  56
  57 - Method 2 - Configure via cli
  58
  59    1. Setup v2rayA
  60
  61       ```sh
  62       # For advanced usage, please see /etc/config/v2raya
  63       uci set v2raya.config.enabled='1'
  64       uci commit v2raya
  65       ```
  66
  67    2. Start v2rayA
  68
  69       ```sh
  70       /etc/init.d/v2raya start
  71       ```
  72
  73    3. Visit v2rayA webUI and enjoy
  74
  75       `http://<your_router_ip>:2017`