Help:Access to Toolforge instances with PuTTY and WinSCP

From Wikitech
Jump to navigation Jump to search
Toolforge
Toolforge logo.svg
Getting started
Developing tools
Additional documentation
v · d · e

Overview

This page documents Single-click solutions for accessing your Toolforge instances using PuTTY and WinSCP.

  • PuTTY is a terminal emulator that has SSH support.
  • WinSCP is a Windows GUI for secure file transfer that has SFTP support.

The instructions below can also be used to login with the ssh command in Linux (i.e. ssh username@login.toolforge.org).

For other Cloud VPS project than Tools, instructions differ.

With the correct settings, a single click shell connection or file transfer is possible, and no command line input trouble is needed.

Prerequisites

Information:

  • USERNAME: your shell username on wikitech and Toolforge (you may find it at Special:Preferences)
  • PATH-TO-YOUR-PRIVATE-KEY: the path and name of your private key file on your local system

Programs:

  • PuTTY
  • WinSCP
  • plink.exe (part of PuTTY suite)
  • Pageant (PuTTY authentication agent, part of both the PuTTY and WinSCP suites)

How to set up PuTTY for direct access to your Toolforge account

You are likely going to set up connections to each of the login servers:

20130526 1941 Putty Login Session tools-dev.png 20130526 1941 Putty Login Session tools-login.png

Make sure private key is compatible with putty. Sometimes you need to convert it using puttygen or generate keys in PuTTY.

The remaining configuration options are identical for all login servers. Of course, you may prefer screen and scroll buffer sizes of your choice:

20130526 1941 Putty Login Window.png 20130526 1941 Putty Login Translations.png

Adding a keep-alive time will prevent your connection from dropping when inactive.

20130526 1941 Putty Login Connection.png 20130526 1941 Putty Login Connection Data.png 20130526 2133 Putty Login Connection SSH Auth.png

In order to start the webservice, input the following commands: 

$ become PROJECT-NAME
$ mkdir public_html
$ webservice start

Use webservice --help to get a full list of arguments.

How to set up WinSCP for direct access to your Toolforge account

With WinSCP you must setup a site pointing to the adequate hostname and change the advanced settings to use your private key file on the authentication tab.

WINSCP screen 2.png

Your project is located in the folder:
/data/project/PROJECT-NAME
Switch to the tool account by giving the protocol option:
sudo -u tools.PROJECT-NAME /usr/lib/sftp-server
Enter the path to your private key

Troubleshooting permissions errors

Sometimes the file system permissions on the tool's directory (/data/project/$TOOL) can get messed up and be missing the group write permission. You can check the current permissions by logging into a bastion and showing the directory:

$ ssh login.toolforge.org
$ ls -ld /data/project/bd808-test
drwxrwsr-x 7 tools.bd808-test tools.bd808-test 4096 Jul 19 15:07 /data/project/bd808-test/

The "drwxrwsr-x" section in the output above is the directory permissions. Each letter tells you something about the permissions mask on the file system:

  • "d" - this is a directory.
  • "rwx" - These are the permissions for the directory's owning user. "r" - read, "w" - write, "x" - eXecute.
  • "rws" - These are the permissions for the directory's owning group. "r" - read, "w" - write, "s" - sticky. Sticky implies execute and also attempts to set the same group ownership on all new files and directories created inside the directory.
  • "r-x" - These are the permissions for "other" users (users who are not the owner or in the owning group). The "-" means that other users cannot write to this directory.

Your user should be a member of the owning group for the directory. When you cannot upload files the problem is often that the "w" write permission is missing for the group on either the tool's directory itself or on a subdirectory or file that you are trying to change. Fixing that is as easy as logging into a bastion, becoming the tool, and changing the permissions:

$ ssh login.toolforge.org
$ become $MY_TOOL
$ chmod -R g+w /data/project/$MY_TOOL
# Recusively grant write permission to the group on all files and directories.

FileZilla

You may also like to use FileZilla for managing files in the remote directory. FileZilla supports SFTP and Putty SSH keys and can be configured with the same configuration settings as above for WinScp. See this link for how to put your SSH key to FileZilla. However, FileZilla lacks the feature of on-login "sudo" SSH command unfortunately. So, you'll stay without "become PROJECT-NAME" forever and your experience won't be very comfortable. There's an issue at FileZilla support site.

You can however route the location to that of your project, and that can be done by replacing it with (usually)/data/project/project_name.

References

Communication and support

We communicate and provide support through several primary channels. Please reach out with questions and to join the conversation.

Communicate with us
Connect Best for
Phabricator Workboard #Cloud-Services Task tracking and bug reporting
IRC Channel #wikimedia-cloud connect
Telegram bridge
mattermost bridge 		General discussion and support
Mailing List cloud@ Information about ongoing initiatives, general discussion and support
Announcement emails cloud-announce@ Information about critical changes (all messages mirrored to cloud@)
News wiki page News Information about major near-term plans
Cloud Services Blog Clouds & Unicorns Learning more details about some of our work
Wikimedia Technical Blog techblog.wikimedia.org News and stories from the Wikimedia technical movement

See Also

Add pages links to related pages here

Retrieved from "https://wikitech.wikimedia.org/w/index.php?title=Help:Access_to_Toolforge_instances_with_PuTTY_and_WinSCP&oldid=1923489"