diff --git a/README.md b/README.md index f93e3e7..bd412cc 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ - [Download/Install](#download-install) - [Install with Brew](#install-with-brew) - [Why Does This Exist](#why) +- [Getting all the Telemetry Out](#disable-telemetry) - [Supported OS](#supported-os) - [Extensions + Marketplace](#extensions-marketplace) - [Migrating from Visual Studio Code to VSCodium](#migrating) @@ -47,6 +48,22 @@ Microsoft's build process does download additional files. This was brought up in - electron - ffmpeg +## <a id="disable-telemetry"></a>Getting all the Telemetry Out +Even though we do not pass the telemetry build flags (and go out of our way to cripple the baked-in telemetry), Microsoft will still track usage by default. After installing VSCodium, you must manually disable telemetry in your settings file to stop it from sending tracking data to Microsoft. + +The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) and [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-crash-reporting) help with disabling telemetry. + +It is also highly recommended that you review all the settings that "use online services" by following [these instructions](https://code.visualstudio.com/docs/supporting/faq#_managing-online-services). The `@tag:usesOnlineServices` filter on the settings page will show that by default: +- Extensions auto check for updates and auto install updates +- Searches within the app are sent to an online service for "natural language processing" +- Updates to the app are fetched in the background + +These can all be disabled. + +__Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.__ + +_(For example the C# extension `ms-vscode.csharp` sends tracking data to Microsoft.)_ + ## <a id="supported-os"></a>Supported OS - [x] OSX x64 (zipped app file) - [x] Linux x64 (`.deb`, `.rpm`, and `.tar.gz` files) diff --git a/build.sh b/build.sh index dfcd98b..067d79f 100755 --- a/build.sh +++ b/build.sh @@ -11,6 +11,8 @@ if [[ "$SHOULD_BUILD" == "yes" ]]; then mv product.json product.json.bak cat product.json.bak | jq 'setpath(["extensionsGallery"]; {"serviceUrl": "https://marketplace.visualstudio.com/_apis/public/gallery", "cacheUrl": "https://vscode.blob.core.windows.net/gallery/index", "itemUrl": "https://marketplace.visualstudio.com/items"}) | setpath(["nameShort"]; "VSCodium") | setpath(["nameLong"]; "VSCodium") | setpath(["applicationName"]; "vscodium") | setpath(["win32MutexName"]; "vscodium") | setpath(["win32DirName"]; "VSCodium") | setpath(["win32NameVersion"]; "VSCodium") | setpath(["win32RegValueName"]; "VSCodium") | setpath(["win32AppUserModelId"]; "Microsoft.VSCodium") | setpath(["win32ShellNameShort"]; "V&SCodium") | setpath(["urlProtocol"]; "vscodium")' > product.json cat product.json + ../undo_telemetry.sh + export NODE_ENV=production if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then diff --git a/undo_telemetry.sh b/undo_telemetry.sh new file mode 100755 index 0000000..10ce5b7 --- /dev/null +++ b/undo_telemetry.sh @@ -0,0 +1,10 @@ +# dc.services.visualstudio.com +# vortex.data.microsoft.com +TELEMETRY_URLS="(dc\.services\.visualstudio\.com)|(vortex\.data\.microsoft\.com)" +REPLACEMENT="s/$TELEMETRY_URLS/0\.0\.0\.0/g" + +if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then + grep -rl --exclude-dir=.git -E $TELEMETRY_URLS . | xargs sed -i '' -E $REPLACEMENT +else + grep -rl --exclude-dir=.git -E $TELEMETRY_URLS . | xargs sed -i -E $REPLACEMENT +fi