This document details what tools are available behind our SOCKS proxy and how to configure access to those tools.

What can I access?

Here are some of the tools you may need access to that are behind the SOCKS proxy:

  • Jenkins for build logs and details (linked to from GitHub PRs for each project).

  • Sentry for exception reports and tracebacks.

  • Grafana/Loki for system metrics and logs for diagnostic/troubleshooting purposes.

  • Prometheus for querying metrics database behind Grafana (also available for sandboxutilitydev, and staging).

For more information on these tools, see Tools Overview in our Request access to tools docs.

How can I set up access?

  1. Ensure you're signed into GitHub AND you can access this page.

    • If you get a 404 even after you've signed in, contact your team lead to get access. If you still need help, reach out to Infrastructure in #vfs-platform-supportYou cannot proceed without this access.

  2. You need to be listed on either the VFS or the Platform roster.

    • If you’re on a VFS team, you need to be listed in the VFS Team Roster.

    • If you’re on a Platform team, you need to be listed on the Platform Roster.

      • If you’re not listed, please reach out to your team leadership about getting added to the Platform Roster.

  3. If you use git in your daily workflow and have already added your SSH keys, skip to step 4. Otherwise, create a GitHub Personal Access Token (with at least “repo” scope permissions).

    • You will use this as your GitHub password when prompted. (As of August 2021, your GitHub password won't work here.)

  4. Follow the process below for configuring your Mac, Linux, or Windows machine. vtk, the gem you’ll install, will walk you through setting up SOCKS, including having you fill out the SOCKS Access Request. Monitor the issue for updates and respond to any questions.

Configuring access on Mac

🎦 Watching the instructional video below first (5m 47s) is recommended.

  1. Open Terminal from your Application's Utilities folder.

    • If you're on Windows, this is the Ubuntu window you just opened.

  2. Within the Terminal, run sudo gem install vtk and enter your system password if prompted.

  3. Run vtk socks setup and follow the prompts.

    • This command will guide you through installing Homebrew, downloading the correct configuration, setting up your key, creating an access request, and configuring your system to access our SOCKS-secured tools.

    • If you do not have a VA key, it will prompt you to create one. Adding a passphrase here is recommended. It will copy the key to your clipboard for you. Upon creation, it will open a SOCKS Access Request issue where you'll paste your key and submit the issue. You'll need to re-run vtk socks setup when your key is approved.

Please see the paragraph at the bottom, “Additional notes on setup,” if you have any questions.

Configuring access on Linux

🎦 Watching the instructional video below first (5m 47s) is recommended. There's a Ubuntu demo at the end of the video.

  1. Install ruby by running sudo apt update && sudo apt install ruby.

    • If you already have a version of ruby installed, you can skip this step.

  2. Follow the instructions in the process above, “Configuring access on Mac.”

Configuring access on Windows

🎦 Watching the instructional video below first (4m 45s) is recommended.

  1. Enable WSL and reboot.

    1. In Windows Search, search "features" and open "Turn Windows features on or off".

    2. Enable "Windows Subsystem for Linux" and click "OK". It will ask you to reboot.

  2. Install and open Ubuntu.

    1. In Windows Search, search "store" and open "Microsoft Store".

    2. In Microsoft Store, search "Ubuntu" and click "Ubuntu 20.04 LTS".

    3. Click the "Install" or "Get" button.

      • You do not need to login if prompted. It may take a moment for the download to begin.

    4. Once the download is finished, in Windows Search, search and open "Ubuntu".

      • On first open, it will ask you to create a user/password.

  3. Follow the instructions in the process above, “Configuring access on Linux.”

Additional notes on setup

  • If you receive any errors regarding version issues, make sure that your system is up-to-date in System Preferences.

  • If you need to re-copy your key, you can run vtk socks setup again and it will prompt you to copy it when the SSH test fails.

  • If you prefer a more manual approach, you can read the old instructions here. You can also review the source code to the setup command.