| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| other:putty_conf [2020/08/26 14:56] – [Using ssh keys] Added a link jypeter | other:putty_conf [2022/08/03 10:59] – [Configuring and using PuTTY/Pageant] jypeter |
|---|
| ====== Configuring and using PuTTY/Pageant ====== | ====== Configuring and using PuTTY/Pageant ====== |
| |
| PuTTY is a free and easy to use [[other:ssh|ssh client]] for **Windows** (7 and 10). You can use it to connect to your favorite remote Linux servers in text mode, and start remote graphical applications if you also have a running [[other:win10wsl#installing_an_x_server|X server]] | PuTTY is a free and easy to use [[other:ssh|ssh client]] for **Windows**. You can use it to connect to your favorite remote Linux servers in text mode, and start remote graphical applications if you also have a running [[other:win10wsl#installing_an_x_server|X server]] |
| |
| ===== Installation ===== | ===== Installation ===== |
| |
| Download and install the [[https://www.chiark.greenend.org.uk/~sgtatham/putty/|latest version of PuTTY]] | Official web site: [[https://www.chiark.greenend.org.uk/~sgtatham/putty/|PuTTY Web site]] |
| | |
| | You can install the latest version of PuTTY directly from [[https://apps.microsoft.com/store/detail/XPFNZKSKLBP7RJ|Microsoft Store]], or download the latest [[https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html|64-bit msi installer]] |
| |
| ===== Launching PuTTY/Pageant ===== | ===== Launching PuTTY/Pageant ===== |
| |
| You could directly launch PuTTY, but it is actually more efficient to launch ''Pageant'', especially if you are regularly going to connect to the same server(s) | You could directly launch PuTTY (''Start'' => ''PuTTY'' => ''PuTTY''), but it is actually **more efficient** to launch ''Pageant'', especially if you are regularly going to connect to the same server(s) |
| |
| ''Start'' => ''PuTTY'' => ''Pageant'' | ''Start'' => ''PuTTY'' => ''Pageant'' |
| * It will seem that nothing happens, but you should get the //Pageant// icon at the bottom right of your screen.\\ {{ :other:putty_01_notes_v2.png?direct |}}\\ Pageant will allow you to create or use existing connection profiles (//Sessions//), and also easily use //ssh keys// (more on //ssh keys// later) | * It will seem that nothing happens, but you should get the //Pageant// icon at the bottom right of your screen.\\ {{ :other:putty_01_notes_v2.png?direct |}}\\ Pageant will allow you to create or use existing connection profiles (//Sessions//), and also easily use [[other:putty_conf#using_ssh_keys|ssh keys]] |
| |
| * If you right click on the //Pageant// icon, you can manage sessions with the ''New Session'' option, use ''Saved Sessions'' profiles and manage //ssh keys// (''View Keys'', ''Add Key'').\\ You can also view/add keys by double clicking on the pageant icon\\ {{ :other:putty_02.png?direct |}} | * If you right click on the //Pageant// icon, you can manage sessions with the ''New Session'' option, use ''Saved Sessions'' profiles and manage //ssh keys// (''View Keys'', ''Add Key'').\\ You can also view/add //ssh keys// by double clicking on the pageant icon\\ {{ :other:putty_02.png?direct |}} |
| |
| ===== Configuring PuTTY ===== | ===== Configuring PuTTY ===== |
| |
| Launch the session/configuration manager: (Right click on) ''Pageant'' => ''New Session''\\ {{ :other:putty_03.png?direct&300 |}} | Launch the PuTTY Configuration manager: (Right click on) ''Pageant'' => ''Saved Sessions'' or ''New Session''\\ {{ :other:putty_03.png?direct&300 |}} |
| |
| * You can keep most PuTTY's default settings. This section will show you how to create your first //session profile//, with some useful options. If you want to add another session later, just ''Load'' an existing (and properly configured) session, ''Save'' it under a new name, and the change the session details | * You can keep most PuTTY's default settings. This section will show you how to create your first //session profile//, with some **recommended options**.\\ \\ If you want to add another session later, just ''Load'' an existing (and properly configured) session, ''Save'' it under a new name, change the session details, and then save the session again |
| |
| * When changing a setting, select a (sub-)**Category in the left part** of the PuTTY Configuration windows, and change the displayed **settings in the right part** of the window. | * When changing a setting, select a (sub-)**Category in the left part** of the PuTTY Configuration window, and change the displayed **settings in the right part** of the window. |
| |
| * After changing the settings of an existing Session, **do not forget to go back to the //Session// category and click ''Save''!** | * After changing the settings of an existing Session, **do not forget to go back to the //Session// category (at the top left of the Putty Configuration window) and click ''Save''!** |
| |
| ==== Creating a new session ==== | ==== Creating a new session ==== |
| |
| In the ''Session'' category: | In the ''Session'' Category: |
| * Specify a **Host Name**: e.g. ''ssh1.lsce.ipsl.fr'' for the LSCE access server | * Specify a **Host Name**: e.g. ''ssh1.lsce.ipsl.fr'' for the //LSCE access server// (also called //LSCE gateway//) |
| * Specify a matching session name in **Saved Sessions**: e.g. ''ssh1'' | * Specify a matching session name in **Saved Sessions**: e.g. ''ssh1'' |
| * Click on **Save** to save the session\\ {{ :other:putty_04.png?direct |}} | * Click on **Save** to save the new session (that will only have default settings for now)\\ {{ :other:putty_04.png?direct |}} |
| | |
| If you are in a hurry, you can connect to the Linux server by clicking on **Open**, but you should first change some useful settings | |
| |
| | If you are in a hurry, you can connect to the Linux server specified in the //Host Name// field by clicking on **Open** |
| ==== Changing some useful settings ==== | ==== Changing some useful settings ==== |
| |
| * In the ''Windows'' => ''Selection'' category: | * ''Load'' an existing session (e.g. the [[#creating_a_new_session|ssh1 profile]] defined above), that will serve as a **template (with the recommended settings)** for the future sessions |
| * Select **xterm** for the mouse buttons behavior. This will allow you to use the mouse buttons in the Putty terminal the same way you would use them in an standard Linux //xterm// terminal: **Copy** text with the left button, and **Paste** it with the middle button\\ {{ :other:putty_05.png?direct |}} | |
| | * In the ''Window'' => ''Selection'' category: |
| | * Select **xterm** in the //Actions of mouse buttons// section.\\ This will allow you to use the mouse buttons in the PuTTY terminal the same way you would use them in an standard Linux //xterm// terminal: |
| | * **Select** and **Copy** text (at the same time) with the **left button** |
| | * **Paste** text with the **middle button**\\ {{ :other:putty_05.png?direct |}} |
| | * In the ''Window'' => ''Appearance'' category: |
| | * You can **choose a font more readable than the default one**!\\ We recommend the **Cascadia Code** font that comes with the [[other:win10apps#windows_terminal|Windows Terminal]] application (which means that you first have to install Windows Terminal first, but you will probably need it anyway) |
| | * Use the ''Change...'' button in the ''Font settings'' section, and select ''Cascadia Code'' and ''Regular'' (you can also experiment with styles different from ''Regular'', and different font sizes)\\ {{ :other:putty_cascadia_font.png?direct |}} {{ :other:putty_cascadia_styles.png?direct |}} |
| * In the ''Connection'' => ''Data'' category: | * In the ''Connection'' => ''Data'' category: |
| * Specify your login name in **Auto-login username**. This way you won't have to type it when you connect to the Linux server\\ {{ :other:putty_06.png?direct |}} | * Specify your login name (on the LSCE servers) in **Auto-login username**. This way you won't have to type it when you connect to the Linux server!\\ {{ :other:putty_06.png?direct |}} |
| | * In the ''Connection'' => ''SSH'' => ''Kex'' category: |
| | * **<wrap hi>Unselect Attempt GSAPPI key exchange</wrap>**!\\ If you forget to do this, connecting to a server will seem to take forever (if it works at all)...\\ {{ :other:putty_gssapi.png?direct |}} |
| * In the ''Connection'' => ''SSH'' => ''Auth'' category: | * In the ''Connection'' => ''SSH'' => ''Auth'' category: |
| * Select **Allow agent forwarding**. This is the same as [[/other:ssh#standard_usage|using ssh with the -A option]]\\ {{ :other:putty_07.png?direct |}} | * Select **Allow agent forwarding**. This is the same as [[/other:ssh#standard_usage|using ssh with the -A option]]\\ {{ :other:putty_07.png?direct |}} |
| * Select **Enable X11 forwarding**. This is the same as [[/other:ssh#standard_usage|using ssh with the -X option]]\\ {{ :other:putty_08.png?direct |}} | * Select **Enable X11 forwarding**. This is the same as [[/other:ssh#standard_usage|using ssh with the -X option]]\\ {{ :other:putty_08.png?direct |}} |
| |
| * When you have finished updating settings, **do not forget to go back to ''Category'' => ''Session'' and Save the session**!\\ {{ :other:putty_09.png?direct |}} | * When you have finished updating the settings, **do not forget to go back to ''Category'' => ''Session'' and Save the session**!\\ {{ :other:putty_09.png?direct |}} |
| | |
| | * Click on ''Open'' to connect to the default host with the default settings, and check that things are working properly\\ The first time you connect to a server, you will get a ''PuTTY Security Alert'' window, where you have to click on ''Accept'' to tell PuTTY that you trust the connection to this new server\\ {{ :other:putty_new_host.png?direct |}} |
| |
| ==== Adding more sessions ==== | ==== Adding more sessions ==== |
| | |
| | [[other:putty_conf#launching_putty_pageant|Start Pageant]], and then the //PuTTY Configuration manager//: (Right click on) ''Pageant'' => ''New Session'' |
| |
| === Direct connection to a remote server === | === Direct connection to a remote server === |
| |
| * Select an existing session (e.g. the [[#creating_a_new_session|ssh1 profile]] defined above) and click on **Load** | * Select an existing session (e.g. the [[#creating_a_new_session|ssh1 profile]] defined above) and click on **Load** |
| * Update the values of the **Host Name** and **Saved Session** (the name of the new profile you want) text fields, and settings\\ e.g. for connecting to LSCE **from INSIDE LSCE** use: | * Update the values of the **Host Name** and **Saved Session** (the name of the new profile you want) text fields, and settings |
| * ''Host Name'' => ''obelix'' | * connecting to **LSCE from INSIDE LSCE**: |
| * ''Saved Session'' => ''obelix (direct connection)'' | * ''Host Name'' => ''obelix'' |
| | * ''Saved Session'' => ''obelix (direct connection)'' |
| | * connecting to [[https://documentations.ipsl.fr/MESO_User/Quick_start.html|ciclad]]: |
| | * ''Host Name'' => ''ciclad.ipsl.upmc.fr'' |
| | * ''Saved Session'' => ''ciclad'' |
| | * do not forget to **specify your ciclad login** in: ''Connection'' => ''Data'' => ''Auto-login username'' |
| | * you will also need an [[other:putty_conf#using_ssh_keys|ssh key]] if you want to connect to ''ciclad'' !! |
| * Go back to ''Category'' => ''Session'' and **Save** the session | * Go back to ''Category'' => ''Session'' and **Save** the session |
| |
| |
| * Select an existing //gateway// session and click on **Load**.\\ For connecting to LSCE **from OUTSIDE LSCE**, select the [[#creating_a_new_session|ssh1 profile]]\\ If you are at LSCE, but use the //eduroam// or the //guest// **WiFi network**, you are considered as being //outside LSCE//! | * Select an existing //gateway// session and click on **Load**.\\ For connecting to LSCE **from OUTSIDE LSCE**, select the [[#creating_a_new_session|ssh1 profile]]\\ If you are at LSCE, but use the //eduroam// or the //guest// **WiFi network**, you are considered as being //outside LSCE//! |
| * In the ''Connection'' => ''SSH'' category, specify the command used to connect to the target server in the **Remote command** field\\ e.g. **for LSCE**, use | * In the ''Connection'' => ''SSH'' category, specify the command used to connect to the target server in the **Remote command** field\\ e.g. **for LSCE**, use: |
| * ''ssh obelix'' | * ''ssh -X -A obelix'' (check the [[other:ssh#standard_usage|useful ssh options]] for more details on the options)\\ {{ :other:putty_10b.png?direct |}} |
| * or ''ssh -X -A obelix'' (check the [[other:ssh#standard_usage|useful ssh options]] for more details)\\ {{ :other:putty_10.png?direct |}} | * Go back to ''Category'' => ''Session'', <wrap hi>specify a new profile name</wrap> in **Saved Sessions** (e.g. ''obelix via ssh1'') and **Save** the session\\ {{ :other:putty_11.png?direct |}} |
| * Go back to ''Category'' => ''Session'', specify a new profile name in **Saved Sessions** (e.g. ''obelix via ssh1'') and **Save** the session\\ {{ :other:putty_11.png?direct |}} | |
| | |
| ===== Daily usage of PuTTY/Pageant ===== | ===== Daily usage of PuTTY/Pageant ===== |
| ==== Starting a session from a desktop shortcut ==== | ==== Starting a session from a desktop shortcut ==== |
| |
| It is also possible to create a shortcut on the desktop to start a specific session! | It is possible to [[https://the.earth.li/~sgtatham/putty/0.77/htmldoc/AppendixA.html#QA.6.4|create a shortcut on the desktop to start a specific session]]! |
| |
| * Right-click on the desktop and select ''New'' => ''Shortcut'' | * Right-click on the desktop and select ''New'' => ''Shortcut'' |
| * Specify the location of ''putty.exe'': ''C:\Program Files\PuTTY\putty.exe'' | * Specify the location of ''putty.exe'' in the //path// field, and click ''Next'':\\ ''%%"C:\Program Files\PuTTY\putty.exe"%%'' (**with** the quotes!) |
| * Specify the name of the shortcut, and save the shortcut\\ e.g. ''obelix via ssh1'' | * Specify the name of the shortcut (as it will appear on the desktop), and save the shortcut\\ e.g. ''obelix via ssh1'' |
| * Right-click on the shortcut and select **Properties**, then add the name of the desired profile to the existing target\\ e.g. ''"C:\Program Files\PuTTY\putty.exe" -load "obelix via ssh1"'' | * Right-click on the shortcut and select **Properties**, then add the name of the desired profile to the content of the //Target// field |
| | * Warning: |
| | * you have to **use an existing session name** (as it appears in ''Pageant'' => ''Session'' => ''Saved Sessions'') |
| | * you have to **use quotes correctly**, otherwise you will get an error message! |
| | * Examples: |
| | * ''%%"C:\Program Files\PuTTY\putty.exe" -load "obelix via ssh1"%%'' |
| | * ''%%"C:\Program Files\PuTTY\putty.exe" -load "obelix (direct)"%%'' |
| * Click **OK** to save the changes | * Click **OK** to save the changes |
| * You can now connect to the remote server just by clicking on the shortcut! | * You can now connect to the remote server just by clicking on the desktop shortcut, instead of right-clicking on the Pageant icon! |
| |
| ===== Using ssh keys ===== | ===== Using ssh keys ===== |
| ==== Importing or creating ssh keys with PuTTYgen ==== | ==== Importing or creating ssh keys with PuTTYgen ==== |
| |
| | * Launch the PuTTY Key Generator:\\ ''Start'' => ''PuTTY'' => ''PuTTYgen'' |
| |
| | * If you already have a private ssh keys generated on another computer, ''id_rsa'', you just have to use PuTTYgen to **import the private key**, and save it to a ''.ppk'' file that ''Pageant'' can use |
| | * Import the key (and type the passphrase, when asked) with: ''Conversions''=>''Import key''\\ {{ :other:putty_21.png?direct&300 |}} |
| | * Then click on the ''Save private key'' button, and create a ''id_rsa.ppk'' file (or ''any_name_you_want.ppk'')\\ {{ :other:putty_22.png?direct&300 |}} |
| |
| | * If you don't have a set of ssh keys, follow the steps below to **create private and public keys** |
| | * Make sure that the type of key (at the bottom of the PuTTYgen window) is ''RSA'' and that the number of bits is ''4096'' |
| | * Click on the ''Generate'' button and move your mouse to generate some random information |
| | * Type your ''Key passphrase'' and confirm it |
| | * Click on the ''Save private key'' button, and create a ''id_rsa.ppk'' file (or ''any_name_you_want.ppk'')\\ {{ :other:putty_23.png?direct&300 |}} |
| | * Click on the ''Save public key'' button, and create a ''id_rsa.pub'' file |
| | * Click on ''Conversions''=>''Export OpenSSH key'', and create a (standard) ''id_rsa'' file\\ You will not need this file with Putty, but it is just in case you need to use your private key later on a Linux computer |
| |
| |
