Skip to content

Commit

Permalink
b/358184320 Update docs, screenshots for 2.44 (#1598)
Browse files Browse the repository at this point in the history
* Update screenshots
* Document new SSH group policy
* Add item to SSH troubleshooting doc
  • Loading branch information
jpassing authored Jan 3, 2025
1 parent 7b24db3 commit 445de44
Show file tree
Hide file tree
Showing 26 changed files with 37 additions and 631 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ For Windows 10 and 11. No admin rights required.

## Access Linux and Windows VMs from anywhere

<a href='doc/images/Screenshot_1400.png?raw=true'>
<img src='doc/images/Screenshot_350.png' align='right'>
<a href='doc/site/sources/docs/images/screenshots/Screenshot_1400.png?raw=true'>
<img src='doc/site/sources/docs/images/screenshots/Screenshot_350.png' align='right'>
</a>

IAP Desktop uses [Identity-Aware-Proxy (IAP)](https://cloud.google.com/iap/docs/tcp-forwarding-overview) to connect to VM instances so that you can:
Expand All @@ -35,8 +35,8 @@ The application automatically manages IAP TCP tunnels for you, and protects them

## Connect to Windows VMs with Remote Desktop

<a href='doc/images/RemoteDesktop_1400.gif?raw=true'>
<img src='doc/images/RemoteDesktop_350.png' align='right'>
<a href='doc/site/sources/docs/images/screenshots/RemoteDesktop_1400.gif?raw=true'>
<img src='doc/site/sources/docs/images/screenshots/RemoteDesktop_350.png' align='right'>
</a>

IAP Desktop is a [full-featured Remote Desktop client](https://googlecloudplatform.github.io/iap-desktop/connect-windows/) that lets you:
Expand All @@ -50,14 +50,14 @@ To help you authenticate to Windows VMs, IAP Desktop can:
* Automatically generate Windows credentials by using the Compute Engine guest agent environment
* Encrypt and store your Windows credentials locally

:arrow_forward: [Show screencast](doc/images/RemoteDesktop_1400.gif?raw=true)
:arrow_forward: [Show screencast](doc/site/sources/docs/images/screenshots/RemoteDesktop_1400.gif?raw=true)

<img src='doc/images/pix.gif' width='100%' height='1'>

## Connect to Linux VMs with SSH

<a href='doc/images/SSH_1400.gif?raw=true'>
<img src='doc/images/SSH_350.png?raw=true' align='right'>
<a href='doc/site/sources/docs/images/screenshots/SSH_1400.gif?raw=true'>
<img src='doc/site/sources/docs/images/screenshots/SSH_350.png?raw=true' align='right'>
</a>

IAP Desktop [includes an SSH client and terminal](https://googlecloudplatform.github.io/iap-desktop/connect-linux/) so that you can:
Expand All @@ -71,15 +71,15 @@ To help you authenticate to Linux VMs, IAP Desktop can:
* Use OS Login [2-factor authentication](https://cloud.google.com/compute/docs/oslogin/set-up-oslogin)
* Store our SSH keys locally using Windows CNG

:arrow_forward: [Show screencast](doc/images/SSH_1400.gif?raw=true)
:arrow_forward: [Show screencast](doc/site/sources/docs/images/screenshots/SSH_1400.gif?raw=true)

<img src='doc/images/pix.gif' width='100%' height='1'>


## Manage VMs across projects

<a href='doc/images/Manage_1400.gif?raw=true'>
<img src='doc/images/Manage_350.png?raw=true' align='right'>
<a href='doc/site/sources/docs/images/screenshots/Manage_1400.gif?raw=true'>
<img src='doc/site/sources/docs/images/screenshots/Manage_350.png?raw=true' align='right'>
</a>

IAP Desktop gives you a consolidated view of your VMs and lets you:
Expand All @@ -91,15 +91,15 @@ IAP Desktop gives you a consolidated view of your VMs and lets you:
* Perform other common operations such as starting or stopping VMs


:arrow_forward: [Show screencast](doc/images/Manage_1400.gif?raw=true)
:arrow_forward: [Show screencast](doc/site/sources/docs/images/screenshots/Manage_1400.gif?raw=true)

<img src='doc/images/pix.gif' width='100%' height='1'>

## Connect to SQL Server and other server applications


<a href='doc/images/Client_700.png?raw=true'>
<img src='doc/images/Client_350.png?raw=true' align='right'>
<a href='doc/site/sources/docs/images/screenshots/Client_700.png?raw=true'>
<img src='doc/site/sources/docs/images/screenshots/Client_350.png?raw=true' align='right'>
</a>

You can use IAP Desktop to let client applications connect to your Google Cloud VMs through IAP:
Expand Down
606 changes: 0 additions & 606 deletions doc/images/Architecture.svg

This file was deleted.

Binary file removed doc/images/Client_350.png
Binary file not shown.
Binary file removed doc/images/Client_700.png
Binary file not shown.
Binary file removed doc/images/Manage_1024.gif
Binary file not shown.
Binary file removed doc/images/Manage_1400.gif
Binary file not shown.
Binary file removed doc/images/Manage_350.gif
Binary file not shown.
Binary file removed doc/images/Manage_350.png
Binary file not shown.
Binary file removed doc/images/Manage_512.gif
Binary file not shown.
Binary file removed doc/images/Overview.png
Binary file not shown.
Binary file removed doc/images/RemoteDesktop_1400.gif
Binary file not shown.
Binary file removed doc/images/RemoteDesktop_350.png
Binary file not shown.
Binary file removed doc/images/SSH_1400.gif
Binary file not shown.
Binary file removed doc/images/SSH_350.gif
Binary file not shown.
Binary file removed doc/images/SSH_350.png
Binary file not shown.
Binary file removed doc/images/Screenshot_1400.png
Binary file not shown.
Binary file removed doc/images/Screenshot_350.png
Binary file not shown.
Binary file removed doc/images/iapdesktop-animated-800.gif
Binary file not shown.
22 changes: 12 additions & 10 deletions doc/site/sources/docs/group-policy-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ setting anymore.

IAP Desktop supports the following policies:

| Policy | Default | Synopsis |
| --------------------------------------------- | ------- |----------------------------------------------------------------------------------------- |
| Enable update checks | On | Periodically check for updates on exit. |
| Enable data sharing | Off | Share anonymous usage data to help Google improve and prioritize features. |
| Enable BeyondCorp certificate-based access | Off | Secure connections to Google Cloud by using BeyondCorp certificate-based access. |
| Enable Workforce Identity | - | Set provider to use for workforce identity federation. |
| Enable Private Service Connect | Off | Use custom Private Service Connect endpoint to connect to connect to Google APIs. |
| Enable HTTPS proxy | - | Set proxy server or autoconfiguration URL. |
| SSH key type | - | Set key type to use for SSH public key authentication. |
| SSH metadata key validity | - | Lifetime for SSH keys published to Compute Engine instance metadata and OS Login. |
| Policy | Default | Synopsis |
|--------------------------------------------|---------|-----------------------------------------------------------------------------------|
| Enable update checks | On | Periodically check for updates on exit. |
| Enable data sharing | Off | Share anonymous usage data to help Google improve and prioritize features. |
| Enable BeyondCorp certificate-based access | Off | Secure connections to Google Cloud by using BeyondCorp certificate-based access. |
| Enable Workforce Identity | - | Set provider to use for workforce identity federation. |
| Enable Private Service Connect | Off | Use custom Private Service Connect endpoint to connect to connect to Google APIs. |
| Enable HTTPS proxy | - | Set proxy server or autoconfiguration URL. |
| SSH key type | - | Set key type to use for SSH public key authentication. |
| SSH metadata key validity | - | Lifetime for SSH keys published to Compute Engine instance metadata and OS Login. |
| Enable SFTP file access | On | Allow users to browse, upload, and download files using SFTP. |


For more information about using group policies to manage IAP Desktop, see
[Use group policies to manage IAP Desktop](group-policies.md).
Binary file modified doc/site/sources/docs/images/02-installer.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 modified doc/site/sources/docs/images/03-signin.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 modified doc/site/sources/docs/images/screenshots/SSH_1400.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified doc/site/sources/docs/images/screenshots/SSH_350.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/site/sources/docs/troubleshooting-rdp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## :material-message-alert: Copy/paste doesn't work

**Symptom**: Unable to copy and paste text or files over RDP
**Symptom**: You can't copy and paste text or files over RDP

This behavior can be caused by an invalid configuration or group policies.

Expand Down
12 changes: 11 additions & 1 deletion doc/site/sources/docs/troubleshooting-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,14 @@ To use ephemeral keys, do the following:
1. Click **OK**.

When you use an ephemeral key and IAP Desktop publishes the public key to OS Login or metadata, it
automatically limits the lifetime of the key to one day.
automatically limits the lifetime of the key to one day.


## :material-message-alert: Copying text from the terminal stops working when running `vim`

**Symptom**: Copying text from the terminal stops working when running `vim` (or certain other programs).

This behavior is expected and a result of the way `vim` handles mouse input. To copy text from `vim`,
use the [`set mouse=r` option](https://vimdoc.sourceforge.net/htmldoc/options.html#'mouse'), or
hold the **Shift** key while coping text.

0 comments on commit 445de44

Please sign in to comment.