-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
proposal(client): move the client to its own subfolder and rename the…
… repository to
- Loading branch information
1 parent
6356371
commit a93cee7
Showing
668 changed files
with
2,707 additions
and
2,605 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 |
|---|---|---|
| @@ -1,28 +1,8 @@ | ||
| node_modules | ||
| .idea | ||
| .vs/ | ||
| .vscode | ||
| *.DS_Store | ||
| *.env | ||
| *.pdb | ||
| *.sw? | ||
| /node_modules | ||
| /build | ||
| /output | ||
| /platforms | ||
| /plugins | ||
| /third_party/Potatso/Pods | ||
| /www | ||
| coverage | ||
| info.txt | ||
| keystore.p12 | ||
| obj/ | ||
| Outline.apk | ||
| Outline.apks | ||
| packages/ | ||
| toc.pb | ||
| tools/OutlineService/OutlineService/bin/* | ||
| tools/smartdnsblock/bin/* | ||
| !tools/OutlineService/OutlineService/bin/*.exe | ||
| !tools/smartdnsblock/bin/*.exe | ||
| universal.apk | ||
| xcuserdata/ |
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
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 |
|---|---|---|
| @@ -1,93 +1,3 @@ | ||
| # Outline Client | ||
| # Outline Apps | ||
|
|
||
|  [](https://community.internetfreedomfestival.org/community/channels/outline-community) [](https://www.reddit.com/r/outlinevpn/) | ||
|
|
||
| > **Test coverage currently only tracks the Apple Libraries and core web view code:** | ||
| > | ||
| > [](https://codecov.io/gh/Jigsaw-Code/outline-client) | ||
| The Outline Client is a cross-platform VPN or proxy client for Windows, macOS, iOS, Android, and ChromeOS. The Outline Client is designed for use with the [Outline Server](https://github.com/Jigsaw-Code/outline-server) software, but it is fully compatible with any [Shadowsocks](https://shadowsocks.org/) server. | ||
|
|
||
| The client's user interface is implemented in [Polymer](https://www.polymer-project.org/) 2.0. Platform support is provided by [Cordova](https://cordova.apache.org/) and [Electron](https://electronjs.org/), with additional native components in this repository. | ||
|
|
||
| To join our Outline Community, [sign up for the IFF Mattermost](https://internetfreedomfestival.org/wiki/index.php/IFF_Mattermost). | ||
|
|
||
| ## Requirements for all builds | ||
|
|
||
| All builds require [Node](https://nodejs.org/) 18 (lts/hydrogen), and [Go](https://golang.org/) 1.20 installed in addition to other per-platform requirements. | ||
|
|
||
| > 💡 NOTE: if you have `nvm` installed, run `nvm use` to switch to the correct node version! | ||
| After cloning this repo, install all node dependencies: | ||
|
|
||
| ```sh | ||
| npm install | ||
| ``` | ||
|
|
||
| ## Building the shared web app | ||
|
|
||
| Outline clients share the same web app across all platforms. This code is located in the src/www directory. If you are making changes to the shared web app and do not need to test platform-specific functionality, you can test in a desktop browser by running: | ||
|
|
||
| ```sh | ||
| npm run action src/www/start | ||
| ``` | ||
|
|
||
| The latter command will open a browser instance running the app. Browser platform development will use fake servers to test successful and unsuccessful connections. | ||
|
|
||
| The app logic is located in [src/www/app](src/www/app). UI components are located in [src/www/ui_components](src/www/ui_components). If you want to work specifically on an individual UI element, try the storybook!: | ||
|
|
||
| ```sh | ||
| npm run action src/www/storybook | ||
| ``` | ||
|
|
||
| > 💡 NOTE: the `src` part of the path is optional. `npm run action www/start` resolves to the same script. | ||
| > 💡 NOTE: every script in this repository can be run with `npm run action` - | ||
| > for a CLI-like experience, add something like | ||
| > | ||
| > ```sh | ||
| > alias outline="npm run action" | ||
| > ``` | ||
| > | ||
| > _(you can call it whatever you like)_ | ||
| > | ||
| > to your shell, then try `outline www/start`! | ||
| ## Passing configuration flags to actions | ||
| Certain actions take configuration flags - but since we're running them through `npm`, you'll have to use the `--` seperator to funnel them through to the underlying process. For example, to set up a MacOS project in release mode, you'd run: | ||
| ```sh | ||
| SENTRY_DSN=<your sentry dsn> npm run action cordova/setup macos -- --buildMode=release --versionName=<your version name> | ||
| ``` | ||
| ## Life of a Packet | ||
| [How does the Outline Client work?](docs/life_of_a_packet.md) | ||
| ## Accepting a server invite | ||
| [Looking for instructions on how to accept a server invite?](docs/invitation_instructions.md) | ||
| ## Platform-specific development | ||
| Each platform is handled differently: | ||
| 1. [Developing for Apple **(MacOS and iOS)**](src/cordova/apple) | ||
| 2. [Developing for **Android**](src/cordova/android) | ||
| 3. [Developing for Electron **(Windows and Linux)**](src/electron) | ||
| ## Error reporting | ||
| To enable error reporting through [Sentry](https://sentry.io/) for local builds, run: | ||
| ```bash | ||
| export SENTRY_DSN=[Sentry development API key] | ||
| [platform-specific build command] | ||
| ``` | ||
| Release builds on CI are configured with a production Sentry API key. | ||
| ## Support | ||
| For support and to contact us, see: https://support.getoutline.org. | ||
| TODO |
File renamed without changes.
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,21 @@ | ||
| /node_modules | ||
| /build | ||
| /output | ||
| /platforms | ||
| /plugins | ||
| /third_party/Potatso/Pods | ||
| /www | ||
| coverage | ||
| info.txt | ||
| keystore.p12 | ||
| obj/ | ||
| Outline.apk | ||
| Outline.apks | ||
| packages/ | ||
| toc.pb | ||
| tools/OutlineService/OutlineService/bin/* | ||
| tools/smartdnsblock/bin/* | ||
| !tools/OutlineService/OutlineService/bin/*.exe | ||
| !tools/smartdnsblock/bin/*.exe | ||
| universal.apk | ||
| xcuserdata/ |
File renamed without changes.
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,93 @@ | ||
| # Outline Client | ||
|
|
||
|  [](https://community.internetfreedomfestival.org/community/channels/outline-community) [](https://www.reddit.com/r/outlinevpn/) | ||
|
|
||
| > **Test coverage currently only tracks the Apple Libraries and core web view code:** | ||
| > | ||
| > [](https://codecov.io/gh/Jigsaw-Code/outline-apps) | ||
| The Outline Client is a cross-platform VPN or proxy client for Windows, macOS, iOS, Android, and ChromeOS. The Outline Client is designed for use with the [Outline Server](https://github.com/Jigsaw-Code/outline-server) software, but it is fully compatible with any [Shadowsocks](https://shadowsocks.org/) server. | ||
|
|
||
| The client's user interface is implemented in [Polymer](https://www.polymer-project.org/) 2.0. Platform support is provided by [Cordova](https://cordova.apache.org/) and [Electron](https://electronjs.org/), with additional native components in this repository. | ||
|
|
||
| To join our Outline Community, [sign up for the IFF Mattermost](https://internetfreedomfestival.org/wiki/index.php/IFF_Mattermost). | ||
|
|
||
| ## Requirements for all builds | ||
|
|
||
| All builds require [Node](https://nodejs.org/) 18 (lts/hydrogen), and [Go](https://golang.org/) 1.20 installed in addition to other per-platform requirements. | ||
|
|
||
| > 💡 NOTE: if you have `nvm` installed, run `nvm use` to switch to the correct node version! | ||
| After cloning this repo, install all node dependencies: | ||
|
|
||
| ```sh | ||
| npm install | ||
| ``` | ||
|
|
||
| ## Building the shared web app | ||
|
|
||
| Outline clients share the same web app across all platforms. This code is located in the src/www directory. If you are making changes to the shared web app and do not need to test platform-specific functionality, you can test in a desktop browser by running: | ||
|
|
||
| ```sh | ||
| npm run action src/www/start | ||
| ``` | ||
|
|
||
| The latter command will open a browser instance running the app. Browser platform development will use fake servers to test successful and unsuccessful connections. | ||
|
|
||
| The app logic is located in [src/www/app](src/www/app). UI components are located in [src/www/ui_components](src/www/ui_components). If you want to work specifically on an individual UI element, try the storybook!: | ||
|
|
||
| ```sh | ||
| npm run action src/www/storybook | ||
| ``` | ||
|
|
||
| > 💡 NOTE: the `src` part of the path is optional. `npm run action www/start` resolves to the same script. | ||
| > 💡 NOTE: every script in this repository can be run with `npm run action` - | ||
| > for a CLI-like experience, add something like | ||
| > | ||
| > ```sh | ||
| > alias outline="npm run action" | ||
| > ``` | ||
| > | ||
| > _(you can call it whatever you like)_ | ||
| > | ||
| > to your shell, then try `outline www/start`! | ||
| ## Passing configuration flags to actions | ||
| Certain actions take configuration flags - but since we're running them through `npm`, you'll have to use the `--` seperator to funnel them through to the underlying process. For example, to set up a MacOS project in release mode, you'd run: | ||
| ```sh | ||
| SENTRY_DSN=<your sentry dsn> npm run action cordova/setup macos -- --buildMode=release --versionName=<your version name> | ||
| ``` | ||
| ## Life of a Packet | ||
| [How does the Outline Client work?](docs/life_of_a_packet.md) | ||
| ## Accepting a server invite | ||
| [Looking for instructions on how to accept a server invite?](docs/invitation_instructions.md) | ||
| ## Platform-specific development | ||
| Each platform is handled differently: | ||
| 1. [Developing for Apple **(MacOS and iOS)**](src/cordova/apple) | ||
| 2. [Developing for **Android**](src/cordova/android) | ||
| 3. [Developing for Electron **(Windows and Linux)**](src/electron) | ||
| ## Error reporting | ||
| To enable error reporting through [Sentry](https://sentry.io/) for local builds, run: | ||
| ```bash | ||
| export SENTRY_DSN=[Sentry development API key] | ||
| [platform-specific build command] | ||
| ``` | ||
| Release builds on CI are configured with a production Sentry API key. | ||
| ## Support | ||
| For support and to contact us, see: https://support.getoutline.org. |
File renamed without changes.
Oops, something went wrong.