Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luisenmarroquin/setup-ssh-action
GitHub Action that sets up your SSH key on the Virtual Environment
https://github.com/luisenmarroquin/setup-ssh-action
actions cd ci ci-cd github github-actions javascript js macos marketplace node node-js secrets ssh ssh-key ts typescript ubuntu windows workflow
Last synced: 10 days ago
JSON representation
GitHub Action that sets up your SSH key on the Virtual Environment
- Host: GitHub
- URL: https://github.com/luisenmarroquin/setup-ssh-action
- Owner: LuisEnMarroquin
- License: mit
- Created: 2020-08-13T08:12:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-02T13:45:47.000Z (about 3 years ago)
- Last Synced: 2024-10-31T10:38:26.383Z (15 days ago)
- Topics: actions, cd, ci, ci-cd, github, github-actions, javascript, js, macos, marketplace, node, node-js, secrets, ssh, ssh-key, ts, typescript, ubuntu, windows, workflow
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/setup-ssh-action
- Size: 148 KB
- Stars: 7
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Setup SSH - GitHub Action
[](https://github.com/LuisEnMarroquin)
[](https://github.com/LuisEnMarroquin)
[](https://github.com/LuisEnMarroquin)
This action sets up your SSH key on `Windows`, `macOS` and `Ubuntu` Virtual Environments
## Example usage
Setup for GitHub
```yml
name: Deployment
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: LuisEnMarroquin/[email protected]
with:
SSHKEY: ${{ secrets.SSH }} # ----- BEGIN RSA PRIVATE KEY----- ...
- run: ssh -T [email protected] || true
```
Setup for your server
```yml
name: Deployment
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: LuisEnMarroquin/[email protected]
with:
ORIGIN: ${{ secrets.HOST }} # example.com || 8.8.8.8
SSHKEY: ${{ secrets.SSH }} # ----- BEGIN RSA PRIVATE KEY----- ...
NAME: production
PORT: ${{ secrets.PORT }} # 3000
USER: ${{ secrets.USER }} # admin
- run: ssh production ls --help
```
## Inputs
| Key | Value Information | Required |
|----------|----------------------------------------------------------------------------------|----------|
| `ORIGIN` | Where to log in, can be a **Domain** or **IP address**, defaults to `github.com` | **No** |
| `SSHKEY` | Your SSH access key, it's better to store it on your repository secrets | **Yes** |
| `NAME` | How you can refer to the SSH key in the next commands, defaults to `ORIGIN` | **No** |
| `PORT` | The port that will be on the SSH config | **No** |
| `USER` | The user that will be on the SSH config | **No** |
Your repo secrets are at: `https://github.com///settings/secrets`