Skip to content

conortm/ghkeys

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ghkeys Build Status Coverage Status

ghkeys is a simple command line tool for syncing server users' authorized SSH keys with those of one or more GitHub accounts.

Via configuration, specify individual GitHub users and/or entire teams, whose SSH keys should either be output directly or written to server users' authorized_keys files.

Installation

go get github.com/conortm/ghkeys

Configuration

Create a config.yml file like config.example.yml:

---
# Replace with your own personal access token:
github_token: my_github_token
# Array of server usernames and the GitHub source(s) of their authorized keys:
users:
  - username: superadmin
    github_users:
      - github_user_1
    github_teams:
      # Specify teams by Org name and team name, separated by a /
      - MyOrg/Team 1
      - MyOrg/Team 2
  - username: admin
    github_users:
      - github_user_1
      - github_user_2
    github_teams:
      - MyOtherOrg/Team 3

Note: Replace my_github_token with your own personal access token.

Usage

To print all keys:

ghkeys -config=/path/to/config.yml

Pass single username argument to print only that user's keys, for example, when using AuthorizedKeysCommand:

ghkeys -config=/path/to/config.yml superadmin

Use the -write flag to write keys to users' authorized_keys files:

ghkeys -config=/path/to/config.yml -write

TODO

License

MIT © Conor McNamara

About

Populate authorized_keys from GitHub users and/or teams

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published