https://github.com/genuinetools/sshb0t

A bot for keeping your ssh authorized_keys up to date with user's GitHub keys, **only** use if you enable 2FA & keep your keys updates.
https://github.com/genuinetools/sshb0t

bot cli github golang ssh

Last synced: 2 days ago
JSON representation

A bot for keeping your ssh authorized_keys up to date with user's GitHub keys, **only** use if you enable 2FA & keep your keys updates.

• Host: GitHub
• URL: https://github.com/genuinetools/sshb0t
• Owner: genuinetools
• License: mit
• Created: 2017-11-13T15:17:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-06T16:36:03.000Z (over 3 years ago)
• Last Synced: 2024-12-14T13:13:28.884Z (9 days ago)
• Topics: bot, cli, github, golang, ssh
• Language: Makefile
• Size: 3.15 MB
• Stars: 280
• Watchers: 5
• Forks: 23
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sshb0t

[![make-all](https://github.com/genuinetools/sshb0t/workflows/make%20all/badge.svg)](https://github.com/genuinetools/sshb0t/actions?query=workflow%3A%22make+all%22)

[![make-image](https://github.com/genuinetools/sshb0t/workflows/make%20image/badge.svg)](https://github.com/genuinetools/sshb0t/actions?query=workflow%3A%22make+image%22)

[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=for-the-badge)](https://godoc.org/github.com/genuinetools/sshb0t)

[![Github All Releases](https://img.shields.io/github/downloads/genuinetools/sshb0t/total.svg?style=for-the-badge)](https://github.com/genuinetools/sshb0t/releases)

A bot for keeping your ssh `authorized_keys` up to date with user's GitHub keys

from `https://github.com/{username}.keys`.

**WARNING:** Only use this if you have two factor auth enabled for your GitHub

account and you make sure to delete old keys from your account.

**Table of Contents**

- [Installation](#installation)

    - [Binaries](#binaries)

    - [Via Go](#via-go)

    - [Running with Docker](#running-with-docker)

- [Usage](#usage)

## Installation

#### Binaries

For installation instructions from binaries please visit the [Releases Page](https://github.com/genuinetools/sshb0t/releases).

#### Via Go

```console

$ go get github.com/genuinetools/sshb0t

```

#### Running with Docker

```console

$ docker run -d --restart always \

    --name sshb0t \

    -v ${HOME}/.ssh/authorized_keys:/root/.ssh/authorized_keys \

    r.j3ss.co/sshb0t --user genuinetools --keyfile /root/.ssh/authorized_keys

```

## Usage

```console

$ sshb0t -h

sshb0t -  A bot for keeping your ssh authorized_keys up to date with user's GitHub keys.

Usage: sshb0t 

Flags:

  --url       GitHub Enterprise URL (default: https://github.com)

  --user      GitHub usernames for which to fetch keys (default: [])

  -d          enable debug logging (default: false)

  --interval  update interval (ex. 5ms, 10s, 1m, 3h) (default: 30s)

  --keyfile   file to update the authorized_keys (default: /home/jessie/.ssh/authorized_keys)

  --once      run once and exit, do not run as a daemon (default: false)

Commands:

  version  Show the version information.

```

[![Analytics](https://ga-beacon.appspot.com/UA-29404280-16/sshb0t/README.md)](https://github.com/genuinetools/sshb0t)