File: README.android.md

package info (click to toggle)
openoverlayrouter 1.2.2%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,604 kB
  • sloc: ansic: 36,723; sh: 272; makefile: 254; xml: 11
file content (86 lines) | stat: -rw-r--r-- 4,367 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
Android
--------

Open Overlay Router includes support for Android devices operating as LISP mobile 
nodes (LISP-MN). There are two implementations of Open Overlay Router merged in a 
single application, for rooted devices and for non-rooted devices. The application 
automatically selects the implementation to run according to the features of the 
device. It is expected that in the future the version executed in rooted devices  
will provide features beyond those available on the non-root devices, however on 
the current version there is just one root-only feature, support for IPv6 RLOCs. 
In both editions, there is a limit of one single EID (IPv4 or IPv6) mapped to one 
or more RLOC interfaces. Even though several interfaces can be managed by Open Overlay 
Router at the same time, they can only be used in an active-backup fashion (no more 
than one interface used at once).

Installation
------------

OOR requires a device with Android 4.0 or higher. Please note that due to a bug on 
Android 4.4.0 and onwards,  OOR will not work properly in no rooted devices with 
Android 4.4.0, 4.4.1, 4.4.2 or 4.4.3. The bug was fixed on Android 4.4.4. To ease 
the installation process we strongly recommend installing OOR through Google Play 
(search for “open overlay router”), however you can also download a precompiled APK 
package file from the Open Overlay Router website or compile the app from sources 
yourself. In any case, if you choose to install OOR without using Google Play, the 
device must be configured to allow the installation of packages from "unknown sources" 
(System Settings -> Security -> Device Administration)

To build Open Overlay Router for Android from source code we recomend you to use 
Android Studio with the Native Development Kit

  * Android Studio: [https://developer.android.com/studio/index.html]

To get the latest version of the OOR source from Github:

    git clone git://github.com/OpenOverlayRouter/oor.git

Import the android folder to Android Studio and select Build APK from the Build menu. 
To install the application, connect your device to the pc, select Run in the Run 
menu and select the device you want to install and run the application.

If you want to avoid installing Android Studio and do everything from the
command line, you need to have the Android SDK and NDK installed, and then
create the `local.properties` file in the android folder, pointing to the
right locations. For example:

    ndk.dir=/home/user/android-sdk/ndk-bundle
    sdk.dir=/home/user/android-sdk

The build is based on Gradle, and the tree is configured to use the Gradle
Wrapper to simplify things. Available build options can be listed by running
in the android folder:

    ./gradlew tasks

The Gradle Wrapper will download the right version of Gradle, and any required
dependencies. To build the APK:

    ./gradlew :app:assembleDebug

If the build finishes successfully, the APK will be located at
`android/app/build/outputs/apk/debug/app-debug.apk`.

The command line build environment for Android can be created quickly in a VM
using Vagrant, by running `vagrant up oor-dev-android` in the top-level
directory of the source tree. Once that VM boots, the `./gradlew
:app:assembleDebug` command can be run in the `/vagrant/android` folder, and
it will produce the APK. For more information about Vagrant see [the main
README.md file](README.md#using-vagrant).

Running Open Overlay Router
---------------------------

Open Overlay Router Android application allows you to start and stop the oor daemon 
and edit the most important parameters of the configuration file. To access the full
list of configurable parameters you have to edit manually the configuration file
located in /sdcard/oor.conf.  Manually edited parameters not present in the 
graphical configuration interface will be overwritten when using the graphical 
configuration editor. 

** Once OOR is running, the source address of the generated traffic is your EID. It 
is possible that the DNS server used by your device doesn't reply to unknow addresses 
like your new EID. We are working to try to fix this problem in a new release.**

Due to the large amount of data generated by the oor daemon, it is recommended 
to set "log level" to 0 when not debugging.