Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vvatanabe/git-ssh-test-server
Standalone Git SSH Test Server
https://github.com/vvatanabe/git-ssh-test-server
Last synced: 24 days ago
JSON representation
Standalone Git SSH Test Server
- Host: GitHub
- URL: https://github.com/vvatanabe/git-ssh-test-server
- Owner: vvatanabe
- License: mit
- Created: 2020-08-17T21:33:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-24T02:33:13.000Z (about 4 years ago)
- Last Synced: 2024-05-21T12:37:59.744Z (6 months ago)
- Language: Go
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# git-ssh-test-server 
Git SSH Test Server is an example server that implements the Git SSH Protocol. It is intended to be used for testing the Git SSH and is not in a production ready state.
Git SSH Server is written in Go, with pre-compiled binaries available for Mac, Linux.
## Installation
### GoBinaries
You can easily install it by making a curl request to [gobinaries.com](http://gobinaries.com/). You don't have to install Go.
```sh
$ curl -sf https://gobinaries.com/vvatanabe/git-ssh-test-server| sh
```
### Go
If you have the Go(go1.14+) installed, you can also install it with go get command.
```sh
$ go get github.com/vvatanabe/git-ssh-test-server
```
If the installation fails, set the environment variable `GO111MODULE` to `on` by the following command.
```
# Bash
$ export GO111MODULE=on
```
### GitHub Release Page
Built binaries are available on Github releases:
https://github.com/vvatanabe/git-ssh-test-server/releases
## Synopsis
```
$ git-ssh-test-server [flags]
```
## Flags
```
--authorized_keys_path string authorized keys path [GIT_SSH_AUTHORIZED_KEYS_PATH] (default "~/.ssh/authorized_keys")
-c, --config string config file path [GIT_SSH_CONFIG] (default "~/.git-ssh-test-server/config.yml")
-h, --help help for git-ssh-test-server
--host_private_key_path string host's private key path [GIT_SSH_HOST_PRIVATE_KEY_PATH] (default "~/.ssh/id_rsa")
--proxy_protocol use proxy protocol [GIT_SSH_PROXY_PROTOCOL]
--port int port number for SSH [GIT_SSH_PORT] (default 22)
--repo_dir string git repositories dir path [GIT_SSH_REPO_DIR] (default "~/git/repo")
--shell_path string git shell path [GIT_SSH_SHELL_PATH] (default "/usr/bin/git-shell")
--shutdown_timeout duration process shutdown timeout [GIT_SSH_SHUTDOWN_TIMEOUT] (default 30s)
--tcp_health_check_port int port number for TCP Health Check [GIT_SSH_TCP_HEALTH_CHECK_PORT] (listen only when you specify port)
-v, --version version for git-ssh-test-server
```
## Config File
### Default Config File
Default par is `~/.git-ssh-test-server/config.yml`.
Default config file extension can be either `.yml` or `.yaml`.
### YAML Structure
```yaml
authorized_keys_path: /home/foo/.ssh/authorized_keys
host_private_key_path: /home/foo/.ssh/id_rsa
port: 2222
proxy_protocol: true
repo_dir: /home/foo/git/repo
shell_path: "/usr/bin/git-shell"
shutdown_timeout: 30s
tcp_health_check_port: 5000
```
## Bugs and Feedback
For bugs, questions and discussions please use the GitHub Issues.