forked from OrchidTechnologies/orchid
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
317 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,4 @@ | |
/*.pem | ||
bundle.js | ||
.idea | ||
site/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Configs | ||
|
||
## Hop Configuration | ||
A configuration specifying all details needed to connect to a single Orchid hop. It begins with `account = ...` | ||
|
||
### Export | ||
To export a hop configuration, you must first add and configure a 'New Hop' within the Orchid iOS or Android application. Once this is complete, select the hop from the main screen. Scroll down and click the purple 'Share Orchid Account' button. This will display a prominant QR code representation of the Hop Configuration that you can scan and import from a different device. Running the QR code through any decoder will reveal the raw configuration contained within. | ||
|
||
### Import | ||
From the main screen within the Orchid iOS or Android application, select `New Hop -> I have a QR code`. You can then click the purple `Scan` button to quickly scan and import a Hop Configuration QR code. Alternatively, if you have the raw Hop Configuration, copy it to your device's clipboard and click the `Paste` button. | ||
|
||
|
||
## Complete Configuration (Hops Configuration) | ||
A configuration made up of the hop configurations for all hops setup within the application. It begins with `hops = ...` | ||
|
||
### Export | ||
From within the Orchid iOS or Android application, open the hamburger menu (`☰`) in the top left corner. Next, go to `Settings -> Manage Configuration (beta) -> Export`. This will display the raw complete configuration (hops configuration). You can copy it to your device's clipboard using the purple `Copy` button at the bottom. Alternatively, you can produce a QR Code representation by clicking the QR Code button immediately to the left of the `Copy` button. | ||
|
||
### Import | ||
From within the Orchid iOS or Android application, open the hamburger menu (`☰`) in the top left corner. Next, go to `Settings -> Manage Configuration (beta) -> Import`. You can either paste the raw configuration into the text field or click on the QR Code button at the bottom to scan a QR Code representation of the configuration. After doing so, click the `Import` button to save. Note that this will overwrite all existing configured hops within the application. |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
![](img/name_logo.png "Orchid Logo") | ||
|
||
Overview | ||
======== | ||
The Orchid network enables a decentralized virtual private network (VPN), | ||
allowing users to buy bandwidth from a global pool of service providers. | ||
|
||
To do this, Orchid uses an ERC-20 utility token called OXT, a new VPN protocol | ||
for token-incentivized bandwidth proxying, and smart-contracts with algorithmic | ||
advertising and payment functions. Orchid's users connect to bandwidth sellers | ||
using a provider directory, and they pay using probabilistic nanopayments so | ||
Ethereum transaction fees on packets are acceptably low. | ||
|
||
Vision | ||
====== | ||
Our vision is to enable secure access to the internet for everyone, everywhere. | ||
Over the coming months, we’ll be releasing more features in our suite of | ||
privacy-enabling tools. We are working towards a decentralized marketplace for | ||
VPN service. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Gathering Logs | ||
|
||
When debugging client-side issues, you might be requested to share logs. These logs provide advanced details about what the Orchid client is doing behind the scenes to provide you with a private browsing experience. This page is designed to help you collect and share the logs. | ||
|
||
# Android Prerequisites | ||
Start by turning on developer and debugging mode on the phone by going to `Settings -> About Phone -> About Software` and tapping on the build number repeatedly until it prompts you to enable developer mode. Then go to `Settings -> Developer Settings -> Turn on USB Debugging`. Finally, you can run the following command on your computer with your phone connected via USB to view the logs. | ||
|
||
## Android and iOS Prerequisites | ||
When you connect your device to your computer, it will prompt you to trust the computer. It is important that you do so. Otherwise, you will be unable to collect logs. | ||
|
||
## Cydia Impactor | ||
The easiest way to gather logs from both iOS and Android devices is through [Cydia Impactor](http://www.cydiaimpactor.com). In the main window, use the select box to pick the correct device (if you only have one mobile device connected to your computer, this will be done for you). Next, go to `Device -> Watch Log...`. A terminal window will appear and it will start to show a streaming syslog from your mobile device. | ||
|
||
## adb logcat (Android) | ||
If you are using an Android device, you can alternatively collect logs through the Android Debug Bridge (ADB). You can follow this [guide](https://www.xda-developers.com/install-adb-windows-macos-linux/) to install adb on Windows, macOS, or Linux. Once installed, you can run the following command in a terminal to view the logs: | ||
|
||
``` | ||
adb logcat | ||
``` | ||
|
||
## Sanitizing the Logs | ||
The logs you gather will contain information from all applications and actions taken on your device during the period that logs are being gathered. These are not all necessary for debugging purposes. You can optionally filter out all lines that do not contain the string `orchid` as a quick way to sanitize the output. You can do this with a command like: | ||
|
||
``` | ||
grep -i 'orchid' client.log | ||
``` | ||
|
||
Where `client.log` is the file containing the syslog output from the device. You should also be careful to filter out your various secret keys from the logs: | ||
|
||
``` | ||
grep -vi 'secret' client.log | ||
``` | ||
|
||
## Sharing the Logs | ||
The logs you gather will be quite long. You almost certainly do not want to paste them in their entirety into something like a Telegram message. Instead, we encourage you to either share them as an attachment via your preferred method of communication. Or if you are using a communication platform that doesn't support attachments, you can utilize a private pastebin service such as [GitHub Gists](https://gist.github.com), which will provide you with a secret URL you can share to grant access to your logs. |
Oops, something went wrong.