Skip to content

Commit

Permalink
Readme diagrams (#43)
Browse files Browse the repository at this point in the history
* update readme with diagram

* fix
  • Loading branch information
therealpaulgg authored Mar 22, 2024
1 parent a958beb commit 3741bb8
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ Also part of this project:
[https://github.com/therealpaulgg/ssh-sync-server](https://github.com/therealpaulgg/ssh-sync-server)
[https://github.com/therealpaulgg/ssh-sync-db](https://github.com/therealpaulgg/ssh-sync-db)

## Diagram

This diagram depicts the following:

1. Initial user setup with server
2. Sequence diagram illustrating a user configuring a new PC
3. Authenticated download request
4. Authenticated upload request

![svg-of-ssh-sync-architecture](https://raw.githubusercontent.com/therealpaulgg/ssh-sync/main/docs/diagrams.svg)

## High-Level Concept

You have a computer which has SSH keys and configuration on them, and on a secondary machine you would like these keys so you are able to access your servers from another machine. This often involves copy-pasting files and also rewriting an SSH configuration file because file paths change, or the operating system changes. This can be quite tedious. This program aims to replace the manual steps involved by allowing a secure method of transferring keys and keeping them all synced in a remote server.
Expand Down
4 changes: 4 additions & 0 deletions docs/diagrams.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/writeup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

A CLI application to sync SSH keys along with a SSH configuration between machines on-demand.

## Diagram

This diagram depicts the following:

1. Initial user setup with server
2. Sequence diagram illustrating a user configuring a new PC
3. Authenticated download request
4. Authenticated upload request

![svg-of-ssh-sync-architecture](https://raw.githubusercontent.com/therealpaulgg/ssh-sync/main/docs/diagrams.svg)

## High-Level Concept

You have a computer which has SSH keys and configuration on them, and on a secondary machine you would like these keys so you are able to access your servers from another machine. This often involves copy-pasting files and also rewriting an SSH configuration file because file paths change, or the operating system changes. This can be quite tedious. This program aims to replace the manual steps involved by allowing a secure method of transferring keys and keeping them all synced in a remote server.
Expand Down

0 comments on commit 3741bb8

Please sign in to comment.