Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve syncing conflicts from repo_sync_working_branch to main #4946

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
09dc903
Update install-live-share-visual-studio.md
Mikejo5000 Apr 18, 2023
3469244
Merge pull request #270 from MicrosoftDocs/Mikejo5000-patch-1
Mikejo5000 Apr 18, 2023
39ded06
Remove references to linux pre-reqs
derekbekoe Apr 19, 2023
8cb7b82
fix errs
derekbekoe Apr 19, 2023
d1d610a
Merge pull request #271 from derekbekoe/dev/debekoe/no-linux-prereq
derekbekoe Apr 19, 2023
3a853d3
Add security section for guestCommandControl
derekbekoe Jun 30, 2023
466f2c4
img
derekbekoe Jun 30, 2023
d04408a
update
derekbekoe Jun 30, 2023
f98f3f3
more update
derekbekoe Jun 30, 2023
f90e6ab
Add security section for guestCommandControl
derekbekoe Jun 30, 2023
38567e8
Merge pull request #274 from MicrosoftDocs/dev/debekoe/update-notific…
derekbekoe Jun 30, 2023
8084e0f
Update Live Share policy docs to include Intune and the new chat policy
curib Aug 31, 2023
64d885d
fix warnings
curib Aug 31, 2023
8f46604
Merge pull request #275 from curib/main
Mikejo5000 Sep 11, 2023
8e2158b
Fix build validation warning
Mikejo5000 Nov 10, 2023
ef9daeb
Merge pull request #277 from Mikejo5000/mikejo-liveshare-3
Mikejo5000 Nov 10, 2023
01cef28
remove docs feedback control
Mikejo5000 Dec 14, 2023
38edd35
Merge pull request #279 from Mikejo5000/mikejo-liveshare-3
Mikejo5000 Dec 14, 2023
27cd83f
Merge pull request #280 from MicrosoftDocs/main
Mikejo5000 Dec 14, 2023
e97cb18
Reverting Feedback Control change
Mikejo5000 Dec 14, 2023
04e460f
Merge pull request #281 from Mikejo5000/mikejo-liveshare-3
Mikejo5000 Dec 14, 2023
64b6b3d
Merge pull request #282 from MicrosoftDocs/main
Mikejo5000 Dec 14, 2023
bbbfb9b
Remove ms.technology = live-share paired with ms.prod = visual-studio…
Jan 23, 2024
2fce18f
Merge pull request #283 from MicrosoftDocs/7b466670-997b-4127-a99e-b5…
learn-build-service-prod[bot] Jan 24, 2024
4b34560
Merge pull request #284 from MicrosoftDocs/main
huypub Jan 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .openpublishing.publish.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@
}
],
"notification_subscribers": [
"[email protected]",
" [email protected]",
" [email protected]",
"[email protected]"
"[email protected]"
],
"sync_notification_subscribers": null,
"branches_to_filter": [],
Expand Down
4 changes: 2 additions & 2 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@
"overwrite": [],
"externalReference": [],
"globalMetadata": {
"ms.subservice": "live-share",
"ms.service": "visual-studio-family",
"feedback_system": "GitHub",
"feedback_github_repo": "MicrosoftDocs/live-share",
"feedback_product_url": "https://aka.ms/vsls-issues/",
"titleSuffix": "Visual Studio Live Share",
"breadcrumb_path": "breadcrumb/toc.yml",
"extendBreadcrumb": true,
"audience": "developer",
"ms.prod": "visual-studio-family",
"ms.technology": "live-share",
"searchScope": ["Live Share"],
"uhfHeaderId": "MSDocsHeader-VisualStudio"
},
Expand Down
2 changes: 1 addition & 1 deletion docs/includes/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
|Product|Installation steps|
|:-------------:|------------|
|![Visual Studio Code logo](../media/vs-code.svg)|**Visual Studio Code (1.22.0+)**<br />1. Install [Visual Studio Code](https://code.visualstudio.com/) for Windows (7, 8.1, or 10), macOS **(High Sierra 10.13+)**</b>, 64-bit Linux ([details](../use/install-live-share-visual-studio-code.md))<br />2. Download and install the Visual Studio Live Share extension from the marketplace. <br />3. Reload and wait for dependencies to download and install (see status bar).<br />4. **Linux**: If prompted to [install libraries](../reference/linux.md#install-linux-prerequisites), click install, enter password, restart VS Code when done.<br /><a href="https://aka.ms/vsls-dl/vscode"><img src="../media/download.png" alt="Download button"></a>|
|![Visual Studio Code logo](../media/vs-code.svg)|**Visual Studio Code (1.22.0+)**<br />1. Install [Visual Studio Code](https://code.visualstudio.com/) for Windows (7, 8.1, or 10), macOS **(High Sierra 10.13+)**</b>, 64-bit Linux ([details](../use/install-live-share-visual-studio-code.md))<br />2. Download and install the Visual Studio Live Share extension from the marketplace. <br /><br /><a href="https://aka.ms/vsls-dl/vscode"><img src="../media/download.png" alt="Download button"></a>|
|![Visual Studio 2019 logo](../media/vs-ide-2019.svg)|**Visual Studio 2019**<br />1. Install [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/).<br/>2. Install a [supported workload](../reference/platform-support.md) (e.g. ASP.NET, .NET Core, C++, Python, and/or Node.js).<br />3. Visual Studio Live Share is installed by default with these workloads. <br />|
|![Visual Studio 2017 logo](../media/vs-ide-2017.svg)|**Visual Studio 2017 15.6 or higher**<br />1. Install the latest version of [Visual Studio 2017](https://visualstudio.microsoft.com/vs/older-downloads/) (15.6+) on Windows (7, 8.1, or 10).<br/>2. Install a [supported workload](../reference/platform-support.md) (e.g. ASP.NET, .NET Core, C++, and/or Node.js).<br />3. Download and install the Visual Studio Live Share extension from the marketplace. <br /><a href="https://aka.ms/vsls-dl/vs"><img src="../media/download.png" alt="Download button" ></a><br />|

Expand Down
Binary file modified docs/media/policies-visual-studio/live-share-policies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/vscode-guest-command-control.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
103 changes: 0 additions & 103 deletions docs/reference/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,107 +20,6 @@ Creative Commons Attribution 4.0 License (International): https://creativecommon

Linux is a highly variable environment and with the sheer number of desktop environments and distributions can be complicated to get working. If you stick to supported versions of **Ubuntu Desktop** (16.04+), **CentOS 7**, or **Fedora Workstation** (27+) and only use **official distributions of VS Code**, you should find the process straight forward. However, in the event that you are using a non-standard configuration or downstream distribution, you may or may not run into some hiccups. This document provides some information on requirements and some troubleshooting details that might help you get up and running even if your configuration is only community supported. Note that Live Share only supports **64-bit Linux**.

## Install Linux prerequisites

Some distributions of Linux are missing libraries Live Share needs to function. By default, Live Share attempts to detect and install Linux prerequisites for you. You'll see a toast notification when Live Share encounters a problem that can originate from missing libraries asking you for permission to install them.

![Toast notification showing message that Linux pre-requisites are missing](../media/vscode-linux-prereq-missing.png)

When you click "Install", a terminal window will appear where your OS will ask you to enter your admin / root (sudo) password to continue. Assuming the script completes successfully, reload Visual Studio Code when prompted 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 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 using the following command in a Terminal window:

```
wget -O ~/vsls-reqs https://aka.ms/vsls-linux-prereq-script && chmod +x ~/vsls-reqs && ~/vsls-reqs
```

## Tips by distribution

While the prerequisite install script above covers a variety of distributions, you may be wondering what is typically missing from vanilla installations. The following list shows the key libraries that were missing in a fresh install of a given distribution. The list also provides some tips that can help you get up and running if you hit a problem.

| Distribution | Vanilla install missing libraries | Additional steps |
|--------|-------------------|----|
| Ubuntu Desktop 22.04 (64-bit) | `libssl1.1` | &lt;none&gt; |
| Ubuntu Desktop 18.04 (64-bit) | &lt;none&gt; | &lt;none&gt; |
| Ubuntu Desktop 16.04 (64-bit) | &lt;none&gt; | &lt;none&gt; |
| Kubuntu 18.04 (64-bit) | `gnome-keyring desktop-file-utils` | &lt;none&gt; |
| Kubuntu 16.04 (64-bit) | `gnome-keyring desktop-file-utils` | &lt;none&gt; |
| Xubuntu 18.04 (64-bit) |&lt;none&gt; | <ul><li>Ensure "Launch GNOME services on startup" is checked in the "Advanced" tab of "Session and Startup".</li><li>If you run into sign-in trouble, install `seahorse`, start "Passwords and Keys", verify you have "Login" keyring and that you can unlock it.</li></ul> |
| Xubuntu 16.04 (64-bit) | &lt;none&gt; | <ul><li>Ensure "Launch GNOME services on startup" is checked in the "Advanced" tab of "Session and Startup".</li><li>If you run into sign-in trouble, install `seahorse`, start "Passwords and Keys", verify you have "Login" keyring and that you can unlock it.</li></ul> |
| Mint 19 Cinnamon (64-bit) | &lt;none&gt; | &lt;none&gt; |
| Mint 18.3 Cinnamon (64-bit) | &lt;none&gt; | &lt;none&gt; |
| Debian 10 (Buster) Testing (64-bit) | Release not stable, so unknown. | <ul><li>Debian Testing and Unstable (Sid) are not officially supported.</li><li>There is a [known issue](https://github.com/dotnet/corefx/issues/33179) in .NET Core that affects Live Share. </li><li>See [here for a workaround](https://github.com/dotnet/corefx/issues/33179#issuecomment-435118249). </li><li>There is a [known issue](https://github.com/MicrosoftDocs/live-share/issues/4000) with WSL certificates. </li></ul> |
| Debian 9 GNOME Desktop (64-bit) | &lt;none&gt; | <ul><li>You may need to install `sudo` and add your user to the sudo group to use the automated install script.</li> |
| Fedora Workstation 29 (64-bit) | `openssl-libs` | &lt;none&gt; |
| Fedora Workstation 28 (64-bit) | &lt;none&gt; | &lt;none&gt; |
| Fedora Workstation 27 (64-bit) | &lt;none&gt; | &lt;none&gt; |
| CentOS 7 GNOME Desktop (64-bit) | &lt;none&gt; | &lt;none&gt; |

See **[tips for community supported distributions](#tips-for-community-supported-distros)** for information about other non-Debian / Ubuntu or RHL based distributions.

Additional details can also be found [below](#detailed-library-requirements) on the specific libraries Live Share needs.

<a name="tips-for-unsupported-distros"></a>

## Tips for community supported distros

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 |
|--------------|----------|-------------------|------------------|
| Arch Linux (64-bit) | Yes | Varies. Possible libraries: `gcr liburcu openssl-1.0 krb5 zlib icu gnome-keyring libsecret desktop-file-utils xorg-xprop icu69` | <ul><li>Supported by the [prerequisite install script](#install-linux-prerequisites).</li><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.</ul> |
| Manjaro 17.1 (64-bit) | Yes | `xorg-xprop liburcu icu69` | <ul><li>Supported by the [prerequisite install script](#install-linux-prerequisites).</li><li>Use the [visual-studio-code-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package for VS Code.</li></ul> |
| openSuSE LEAP 15 KDE (64-bit) | Yes | `libopenssl1_0_0 gnome-keyring` | <ul><li>Supported by the prerequisite install script.</li></ul> |
| Solus 3 (64-bit) | Yes | `xprop` | <ul><li>Supported by the [prerequisite install script](#install-linux-prerequisites).</li><li>Versions of the `vscode` package prior to release 57 were missing required product.json values ([see below](#vs-code-oss-issues)). Upgrade the `vscode` package to resolve this issue.</li></ul> |
| Gentoo (64-bit) | Yes | Highly variable. Possible missing packages: `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 x11-apps/xprop`| <ul><li>The `visual-studio-code` package in the **jorgicio** overlay is known to work.</li></ul>

## Install prerequisites manually

While we recommend using Live Share's **dependency install script**, this section provides further details on library requirements in the event you want perform these steps yourself or are using a distribution not supported by the script.

Typical missing libraries in vanilla installations can be found in the [tips by distribution](#tips-by-distribution) and [tips for community supported distributions](#tips-for-unsupported-distros) sections.

### Detailed library requirements

Visual Studio Live Share's native library requirements come from its use of .NET Core 2.1, libsecret to persist credentials, and its browser integration. The following table summarizes these requirements for distributions officially supported by .NET Core.

| Distribution | .NET Core Reqs | Credential Storage Reqs| Browser Integration Reqs |
|--------------|-----------|--------------------|------------|
| Ubuntu and downstream distributions | `libssl1.0.0 libkrb5-3 zlib1g libicu55` (for Ubuntu 16.04, Mint 18.3) or `libicu57` (for Ubuntu 17.10) or `libicu60` (for Ubuntu 18.04, Mint 19) | `libsecret-1-0 gnome-keyring` (or libsecret supported keyring - Kwallet does not support libsecret) | `desktop-file-utils x11-utils` |
| Debian 9 and downstream distributions | `libssl1.0.2 libkrb5-3 zlib1g libicu57` | `libsecret-1-0 gnome-keyring` (or libsecret supported keyring - Kwallet does not support libsecret) | `desktop-file-utils x11-utils` |
| RHL / CentOS/ Fedora | `openssl-libs krb5-libs zlib libicu` Fedora also requires `openssl-libs`| `libsecret gnome-keyring` (or libsecret supported keyring - Kwallet does not support libsecret) | `desktop-file-utils xprop` |
| Alpine Linux | `openssl1.1 icu krb5 zlib` | `libsecret gnome-keyring` (or libsecret supported keyring - Kwallet does not support libsecret) | `desktop-file-utils xprop`

While other distributions require the same libraries, their package names may vary. You can find some of these in the [tips for community supported distributions](#tips-for-unsupported-distros) section.

### Debian / Ubuntu

Libraries may be installed on Debian/Ubuntu based distributions by running `sudo apt install <library-name>` in a terminal.

For Ubuntu based distributions including Mint, run:

```
sudo apt install libssl1.1 libkrb5-3 zlib1g libicu[0-9][0-9] gnome-keyring libsecret-1-0 desktop-file-utils x11-utils
```

For Debian 9 and non-Ubuntu downstream distributions, run:

```
sudo apt install libssl1.0.2 libkrb5-3 zlib1g libicu57 gnome-keyring libsecret-1-0 desktop-file-utils x11-utils
```

### Fedora / CentOS / RHL

Libraries may be installed on Fedora/CentOS/RHL based distributions by running `sudo yum install <library-name>` in a terminal. For example, this will install everything:

```
sudo yum install openssl-libs krb5-libs zlib libicu libsecret gnome-keyring desktop-file-utils xprop
```

## VS Code OSS Issues

> **Arch Linux/Manjaro Users:** Use the [visual-studio-bin](https://aur.archlinux.org/packages/visual-studio-code-bin) AUR package to avoid this problem.
Expand All @@ -146,8 +45,6 @@ As a **workaround**, you can add the following into the product.json:
]
```

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

## Linux browser integration

Visual Studio Live Share typically **does not require additional installation steps** to enable browser integration on Linux.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.workload:

Notebooks have become a key part of many developer's and data scientist's workflow. With Visual Studio Code offering a rich, native notebook-editor, we're excited to enable a real-time collaboration experience, that will allow teams and classrooms to use notebooks and Live Share together.

The Live Share notebook experience is currently in preview, and therefore, has some [pre-requisitions](#pre-requisites) and [known issues](#known-issues) to be aware of. We'll be iterating rapidly on this initial preview release, and therefore, please don't hesitate to [send us any questions/feedback](http://github.com/microsoftdocs/live-share)) as you're evaluating it 👍<br />
The Live Share notebook experience is currently in preview, and therefore, has some [pre-requisitions](#pre-requisites) and [known issues](#known-issues) to be aware of. We'll be iterating rapidly on this initial preview release, and therefore, please don't hesitate to [send us any questions/feedback](https://github.com/microsoftdocs/live-share)) as you're evaluating it 👍<br />

<img width="800px" src="https://user-images.githubusercontent.com/116461/105928037-0d07a680-5ffa-11eb-8447-23bdb77fee9e.png" title="Notebook collaboration" alt="Notebook collaboration"/>

Expand Down
9 changes: 9 additions & 0 deletions docs/reference/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,15 @@ You can **always reject** (disable anonymous guests) or **always accept** anonym

**Regardless, remember that you should only send Live Share invitation links to people you trust.**

### Allowing guest command control

![VS Code: The host doesn't allowing running this command.](../media/vscode-guest-command-control.png)

To allow guests to run arbitrary commands via Code Actions (“Quick Fixes”) and CodeLens set the following setting:

* In **VS Code**, set `liveshare.languages.allowGuestCommandControl` in settings.json (File > Preferences > Settings) to `true` or `false` (the default).


## Controlling file access and visibility

As a guest, Live Share's remote model gives you quick read/write access to files and folders the host has shared with you without having to sync the entire contents of a project. You can therefore independently navigate and edit files in the entire shared file tree. **However, this freedom does pose some risks to the host.** In concept, a developer could opt to go in and modify source code without your knowledge or see sensitive source code or "secrets" located somewhere in the shared file tree. Consequently, as a host, you may not always want the guest to have access to the entirety of a project you are sharing. Thankfully, an added advantage of this remote model is that you can opt to "exclude" files you do not want to share with anyone without sacrificing on functionality. Your guests can still participate in things like debugging sessions that would normally require access to these files if they wanted to do so on their own.
Expand Down
Loading