mcr update and readme (#9)
All checks were successful
code scans / scans (push) Successful in 24s
All checks were successful
code scans / scans (push) Successful in 24s
Reviewed-on: #9 Co-authored-by: jake <jake.young.dev@gmail.com> Co-committed-by: jake <jake.young.dev@gmail.com>
This commit was merged in pull request #9.
This commit is contained in:
29
README.md
29
README.md
@@ -1,20 +1,24 @@
|
||||
# mctl
|
||||
mctl is a terminal-friendly remote console client
|
||||
|
||||
## Index
|
||||
# Index
|
||||
1. [Installation](#installation)
|
||||
2. [Setup](#setup)
|
||||
3. [Documentation](#documentation)
|
||||
4. [Security](#security)
|
||||
5. [Development](#development)
|
||||
|
||||
## Installation
|
||||
<br />
|
||||
|
||||
# Installation
|
||||
Install mctl using golang
|
||||
```bash
|
||||
go install code.jakeyoungdev.com/jake/mctl@main #it is recommended to use a tagged version
|
||||
```
|
||||
|
||||
## Setup
|
||||
<br />
|
||||
|
||||
# Setup
|
||||
### Configuring mctl
|
||||
mctl requires a one-time setup via the 'config' command before interacting with any servers, password is entered securely from the terminal and encrypted
|
||||
```bash
|
||||
@@ -88,7 +92,9 @@ To clear all fields from the configuration file use:
|
||||
mctl clear
|
||||
```
|
||||
|
||||
## Documentation
|
||||
<br />
|
||||
|
||||
# Documentation
|
||||
### Commands
|
||||
|Command|Description|
|
||||
|---|---|
|
||||
@@ -100,20 +106,17 @@ mctl clear
|
||||
|run \<name> args...|runs saved command filling placeholders with supplied args|
|
||||
|clear|clears config file|
|
||||
|
||||
### Flags
|
||||
#### config
|
||||
|Flag|Shorthand|Required|Description|
|
||||
|---|---|---|---|
|
||||
|port|p|yes|RCon port|
|
||||
|server|s|yes|RCon address|
|
||||
|
||||
### Configuration file
|
||||
All configuration data will be kept in the home directory and any sensitive data is encrypted for added security
|
||||
|
||||
## Security
|
||||
<br />
|
||||
|
||||
# Security
|
||||
RCon is an inherently insecure protocol, passwords are sent in plaintext and, if possible, the port should not be exposed to the internet. It is best to keep these connections local or over a VPN.
|
||||
|
||||
mctl utilizes [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) and [gosec](https://github.com/securego/gosec) in workflows to ensure quality, secure code is being pushed. These workflow steps must pass before a PR will be accepted
|
||||
|
||||
## Development
|
||||
<br />
|
||||
|
||||
# Development
|
||||
this repo is currently in development and may encounter breaking changes, use a tag to prevent any surprises
|
||||
Reference in New Issue
Block a user