Skip to content

Commit

Permalink
Merge pull request microsoft#78 from MicrosoftDocs/master
Browse files Browse the repository at this point in the history
Update gentoo and solus support details
  • Loading branch information
Chuxel committed May 24, 2018
2 parents b78810b + 96b3323 commit 997ee4f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
27 changes: 15 additions & 12 deletions docs/reference/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Some distributions of Linux are missing libraries Live Share needs to function.

When you click "Install", a terminal window will appear where you'll need to enter your admin (sudo) password to continue. Assuming it completes successfully, restart Visual Studio Code you should be all set! You may also want to check out **[tips by distribution](#tips-by-distribution)** for other hints and workarounds if any exist.

If you see a message indicating the script does not support your distribution, see **[tips for unsupported distributions](#tips-for-unsupported-distros)** for community tips and issues.
If you see a message indicating the script does not support your distribution, see **[tips for community supported distributions](#tips-for-unsupported-distros)** for information the community has shared with us.

If you **prefer not to have VS Code run the command for you**, you can also opt to re-run the very latest version of this script at any time manually by running the following command from a Terminal window:

Expand Down Expand Up @@ -134,35 +134,38 @@ While the prerequisite install script above should cover Debian / Ubuntu and RHL
| CentOS 7 GNOME Desktop (64-bit) | <none> | <none> |
| openSuSE 12 (64-bit) | <none> | <none> |

See **[tips for unsupported distributions](#tips-for-unsupported-distros)** for information about whether certain non-Debian / Ubuntu or RHL based distributions are working or not.
See **[tips for community supported distributions](#tips-for-community-supported-distros)** for information about whether certain non-Debian / Ubuntu or RHL based distributions are working or not.

Note that the Linux ecosystem moves quickly and package names will be different in certain distributions, so your results may vary. Additional details can be found above on the libraries Live Share needs.

## Tips for unsupported distros
## Tips for community supported distros
<a name="tips-for-unsupported-distros"></a>

Distributions outside of the Debian / Ubuntu or RHL trees are not officially supported by Visual Studio Code or .NET Core. Therefore, by extension, they are not officially supported by Visual Studio Live Share either. However, the Live Share community has helped understand whether Live Share is working on certain unsupported, if so, how to get it up and running.
Distributions outside of the Debian / Ubuntu or RHL trees are not officially supported by Visual Studio Code or .NET Core. Therefore, by extension, they are not officially supported by Visual Studio Live Share either. However, the community has contributed some useful information about getting Live Share up and running on a number of additional distributions.

> **PRs welcome:** If you're interested in updating this information with your favorite distribution, submit a PR for [this file](https://github.com/MicrosoftDocs/live-share/tree/master/docs/reference/linux.md) in our docs GitHub repo. Even better, if you'd like to get the dependency installer supporting your favorite distribution, you can submit a PR [for this file](https://github.com/MicrosoftDocs/live-share/blob/master/scripts/linux-prereqs.sh).
| Distribution | Working? | Vanilla install missing libraries | Additional Steps |
|--------------|----------|-------------------|------------------|
| ArchLinux | Yes | Varies. Use the prerequisite install script. Most common are `gnome-keyring` and `libsecret`. | <ul><li>Use the [visual-studio-code-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package for VS Code.</li><li>`sudo` will need to be installed to use the automated prerequisite install script.</li><li>`gnome-keyring` may require additional [setup steps](https://wiki.archlinux.org/index.php/GNOME/Keyring) in some desktop environments.</lu><li>If you have custom compiled curl or libcurl, be sure to included Kerberos support (the default package includes it). See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul> |
| Manjaro 17.1 | Yes | Use the prerequisite install script. | <ul><li>Use the [visual-studio-code-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package for VS Code.</li><li>If you have custom compiled curl or libcurl, be sure to included Kerberos support (the default package includes it). See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul> |
| Solus 3 | **No** | A version of libcurl with Kerberos support. |**Issues:** <ul><li>VS Code package is missing product.json values ([see below](#vs-code-oss-issues)).</li><li>VS Live Share requires Kerberos support be compiled into libcurl which is not the case for the Solus package. You will need to custom compile a version of curl with Kerberos support to use Live Share. See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul> |
| Gentoo | **With Effort** | Highly variable, but commonly missing a version of libcurl with Kerberos support. | **Issue:** <ul><li>Among other dependencies, VS Live Share requires Kerberos support be compiled into libcurl which is not the default for Gentoo. See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul> |
| ArchLinux | Yes | Varies. Use the prerequisite install script. Most common are `gnome-keyring` and `libsecret`. | <ul><li>Use the [visual-studio-code-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package for VS Code.</li><li>`sudo` will need to be installed to use the automated prerequisite install script.</li><li>`gnome-keyring` may require additional [setup steps](https://wiki.archlinux.org/index.php/GNOME/Keyring) in some desktop environments.</lu><li>If you have custom compiled curl or libcurl, be sure to include Kerberos support (the default package includes it). See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul> |
| Manjaro 17.1 | Yes | Use the prerequisite install script. | <ul><li>Use the [visual-studio-code-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package for VS Code.</li><li>If you have custom compiled curl or libcurl, be sure to include Kerberos support (the default package includes it). See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul> |
| Solus 3 | Yes | None, but be sure the installed `curl` package is at least release 40 and the `vscode` package is at least 57. | <ul><li>Versions of the `vscode` package prior to release 57 were missing required product.json ([see below](#vs-code-oss-issues)).</li><li>Versions of `curl` prior to release 40 did not include Kerberos support required by .NET Core and Live Share. This support was added to unstable on 5/23/2018 and expected to land in stable by **5/25/2018**.</li></ul> |
| Gentoo | Yes | Highly variable, but commonly missing a version of `net-misc/curl` built with the `kerberos` USE flag.<br /><br>Other possible missing packages: `sys-libs/libunwind dev-util/lttng-ust dev-libs/openssl-1.0.2 net-libs/libgsasl dev-libs/icu sys-libs/zlib sys-apps/util-linux app-crypt/libsecret gnome-base/gnome-keyring`| <ul><li>The `visual-studio-code` package in the **jorgicio** overlay is known to work.</li><li>`net-misc/curl` must be compiled with Kerberos support. Add the `kerberos` USE flag to your /etc/portage/package.use file/folder for the package and install/reinstall. See [here](https://github.com/MicrosoftDocs/live-share/issues/212) for details.</li></ul>

### VS Code OSS Issues

> **ArchLinux/Manjaro Users:** Use the [visual-studio-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package to avoid this problem.
Non-official distributions of Visual Studio Code can be missing a critical value in `product.json` file that prevents Visual Studio Live Share from activating. In this case, if you go to Help > "Toggle Developer Tools", you will see stack traces indicating the Live Share extension did not activate due to it using a "proposed API."
Packages of Visual Studio Code that are either vanilla or modified versions of VS Code OSS can be missing a critical value in `product.json` file that prevents Visual Studio Live Share from activating.

To verify this is your issue, check the contents of `product.json`. The file could be located in one of the following locations:
A quick way to see you might be hitting this problem is to go to Help > "Toggle Developer Tools" and see if you find a stack trace indicating the Live Share extension did not activate because it was using a "proposed API."

To verify this is your issue, check the contents of `product.json`. The file's location does vary by package, but it is usually in one of the following locations:

- `/usr/share/code/resources/app/product.json`
- `/usr/share/vscode/resources/app/product.json`

If the `extensionAllowedProposedApi` property is missing or you do not see "ms-vsliveshare.vsliveshare" referenced, you are using an unofficial version with this problem. **Contact the VS Code distribution owner to get the issue patched.**
If the `extensionAllowedProposedApi` property is missing or you do not see "ms-vsliveshare.vsliveshare" referenced, you are using an OSS version with this problem. **Contact the VS Code distribution owner to get the issue patched.**

As a **workaround**, you can add the following into the product.json:

Expand All @@ -172,7 +175,7 @@ As a **workaround**, you can add the following into the product.json:
"ms-vscode.node-debug2"
 ]

See [above](#tips-for-unsupported-distros) for additional details on whether the distribution you are using is known to work.
See [above](#tips-for-community-supported-distros) for additional details on whether the distribution you are using is known to work.

## See also

Expand Down
2 changes: 1 addition & 1 deletion docs/use/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Some distributions of Linux are missing libraries Live Share needs to function.

When you click "Install", a terminal window will appear where you'll need to enter your admin (sudo) password to continue. Assuming it completes successfully, restart Visual Studio Code you should be all set! You may also want to check out **[tips by distribution](../reference/linux.md#tips-by-distribution)** for other hints and workarounds if any exist.

If you see a message indicating the script does not support your distribution, see **[tips for unsupported distributions](../reference/linux.md#tips-for-unsupported-distros)** for community tips and issues.
If you see a message indicating the script does not support your distribution, see **[tips for community supported distributions](../reference/linux.md#tips-for-community-supported-distros)** for information the community has shared with us.

If you **prefer not to have VS Code run the command for you**, you can also opt to re-run the very latest version of this script at any time manually by running the following command from a Terminal window:

Expand Down

0 comments on commit 997ee4f

Please sign in to comment.