https://github.com/guardianproject/orbot-android
The Github home of Orbot: Tor on Android (Also available on gitlab!)
https://github.com/guardianproject/orbot-android
anonymity anticensorship censorship-circumvention security tor
Last synced: 17 days ago
JSON representation
The Github home of Orbot: Tor on Android (Also available on gitlab!)
- Host: GitHub
- URL: https://github.com/guardianproject/orbot-android
- Owner: guardianproject
- License: other
- Created: 2014-05-21T05:03:06.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-04-18T13:17:31.000Z (10 months ago)
- Last Synced: 2025-05-09T04:37:56.718Z (9 months ago)
- Topics: anonymity, anticensorship, censorship-circumvention, security, tor
- Language: Java
- Homepage: https://gitlab.com/guardianproject/orbot
- Size: 935 MB
- Stars: 2,492
- Watchers: 138
- Forks: 368
- Open Issues: 266
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [Orbot](https://orbot.app)
### *Android Onion Routing Robot*
[](https://hosted.weblate.org/engage/guardianproject/)
[](https://play.google.com/store/apps/details?id=org.torproject.android)
[](https://app.bitrise.io/app/0e76c31b8e7e1801) ([CI docs](./docs/info/CI.md))
Orbot is a free VPN and proxy app that empowers other apps to use the internet more securely. Orbot uses Tor to encrypt your Internet traffic and then hides it by bouncing through a series of computers around the world. Tor is free software and an open network that helps you defend against a form of network surveillance that threatens personal freedom and privacy, confidential business activities and relationships, and state security known as traffic analysis.
Orbot is a crucial component of the Guardian Project, an initiative that leads an effort
to develop a secure and anonymous smartphone. This platform is designed for use by human rights
activists, journalists and others around the world. Learn more:
Tor protects your privacy on the internet by hiding the connection
between your Internet address and the services you use. We believe that Tor
is reasonably secure, but please ensure you read the usage instructions and
learn to configure it properly. Learn more:
Download the Latest Orbot Release
Tor FAQ (Frequently Asked Questions)
Please Contribute Your Translations
### Build Instructions
Orbot is built with [hev-socks5-tunnel](https://github.com/heiher/hev-socks5-tunnel). Before you can build Orbot, you'll need to clone the submodule
for this dependency. Once cloned, Android Studio + Gradle will take care of building the C code.
```bash
git clone --recursive https://github.com/guardianproject/orbot-android
```
Or, if you already cloned the repo:
```bash
cd orbot-android
git pull
git submodule update --init --recursive
```
If you pull and see that there are changes to `app/src/main/jni/hev-socks5-tunnel` that means that `hev-socks5-tunnel` was updated. You need to re-run `git submodule update --init --recursive` to fetch the latest changes and then rebuild Orbot.
### Viewing Logs
Recently `tor` was added to be its own Linux process on Android instead of having it run within the primary app process. That measn that you will no longer see logs from `tor`, `OrbotService`, `OrbotVPNManager` etc within Android Studio. In order to see these logs you can use:
`adb logcat --pid=$(adb shell pidof -s "org.torproject.android.debug") -v color` to see the app logs in your terminal
`adb logcat --pid=$(adb shell pidof -s "org.torproject.android.debug:tor") -v color` and to see the `tor` process logs.
**There is a helper script to get both of these logs printed side-by-side with `tmux`. From the root directory run:
```bash
./scripts/view_logs_tmux.sh
```
You may need to initially do some configuration to obtain `tmux` and add `adb` to your `PATH`:
```bash
# on Mac OS
brew install tmux
# on debian + friends:
sudo apt intstall tmux
# then make sure adb is in your path in your .bashrc or similar file:
export ANDROID_HOME=~/Android/Sdk
export PATH=$PATH:$ANDROID_HOME/platform-tools
# on mac you do the above or instead get an adb instance from brew...
brew install android-platform-tools
```
**Copyright © 2009-2026, Nathan Freitas, The Guardian Project**