The Foxpass Developer Hub

Welcome to the Foxpass developer hub. You'll find comprehensive guides and documentation to help you start working with Foxpass as quickly as possible, as well as support if you get stuck.

Get Started    API Reference

Set Up SSH Key Management

Foxpass helps users self-service their SSH key management and provides easy access services for servers. Additionally, Foxpass provides extra features like temporary access and pattern based host matching.

How to Configure Host Access Through Foxpass

  1. Integrate Foxpass with your hosts
    • Run the Foxpass setup script on your current hosts. See the 'Linux Configuration' section on the left-hand side for further instructions.
    • Add the script into your startup script or a configuration management tool like Chef or Puppet. That way whenever you spin up a new instance it will already be configured with Foxpass.
  2. Generate & upload your SSH key
    • Follow the instructions on 'Adding your SSH key to Foxpass' to generate and upload an SSH key to Foxpass. You can upload an existing public key if you have one already.
    • Make sure your user type is set as 'Engineering' or else the SSH key management feature will not be available.

At this point you should be able to log into any configured host using the SSH key you uploaded to Foxpass.

  1. Next Steps: Extra options for more advanced usage.
    • Set automatic SSH Key expiration. Go to the 'Config' page and go to the 'SSH Key expiration' panel to set an expiration. Users will automatically receive an email when their SSH key is about to expire with a prompt to upload a new one.
    • Add a 'foxpass-sudo' group. If you'd like to run 'sudo' commands on the host without having to re-enter your password, create a group named 'foxpass-sudo' here. Add yourself or any other users who need easy sudo access to the host as needed.
    • Manage your organization. Admins can also manually manage other users SSH keys from the 'Users' page under the 'More Actions' dropdown. Admins can upload, enable, disable, or 1-click disable all SSH keys for a particular engineering user.
    • Enable host groups for temporary access controls. Host groups allow you to grant users or groups temporary or permanent access to your infrastructure. They're a great way to enforce the Principal of Least Privilege across your organization.
    • Integrate with API to automate access. Check out the API endpoints on the left-hand panel.

Updated 8 months ago

Set Up SSH Key Management

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.