Russtopia/xs
2
1
Fork 0
mirror of https://gogs.blitter.com/RLabs/xs synced 2024-08-14 10:26:42 +00:00
Code Issues Projects Releases Wiki Activity

Update 'README.md'

Browse source
This commit is contained in:
Russtopia 2018-11-13 23:57:36 -08:00
parent be7f84adcf
commit 43221cbba6
1 changed files with 21 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -74,18 +74,33 @@ Get source code
* $ cd $GOPATH/src/blitter.com/go/hkexsh * $ cd $GOPATH/src/blitter.com/go/hkexsh
* $ go build ./... # install all dependent go pkgs * $ go build ./... # install all dependent go pkgs
To build To build
-- --
* $ cd $GOPATH/src/blitter.com/go/hkexsh * $ cd $GOPATH/src/blitter.com/go/hkexsh
* $ make clean all * $ make clean all
To install
--
* $ sudo make install
An example init script (hkexshd.initrc) is provided. Consult your Linux distribution documentation for proper service/daemon installation. Default assumes installation in /usr/local/sbin (hkexshd, hkexpasswd) and /usr/local/bin (hkexsh/hkexcp symlink).
To uninstall
--
* $ sudo make uninstall
To set accounts & passwords: To set accounts & passwords:
-- --
* $ sudo touch /etc/hkexsh.passwd * $ sudo touch /etc/hkexsh.passwd
* $ sudo hkexpasswd/hkexpasswd -u joebloggs * $ sudo hkexpasswd/hkexpasswd -u joebloggs
* $ <enter a password, enter again to confirm> * $ <enter a password, enter again to confirm>
Running Clent and Server
Testing Client and Server from $GOPATH dev tree
-- --
In separate shells A and B: In separate shells A and B:
* [A]$ cd hkexshd && sudo ./hkexshd & # add -d for debugging * [A]$ cd hkexshd && sudo ./hkexshd & # add -d for debugging
@ -106,7 +121,7 @@ Setting up an 'authtoken' for scripted (password-free) logins
-- --
Use the -g option of hkexsh to request a token from the remote server, which will return a Use the -g option of hkexsh to request a token from the remote server, which will return a
hostname:token string. Place this string into $HOME/.hkexsh_id to allow logins without hostname:token string. Place this string into $HOME/.hkexsh_id to allow logins without
entering a password (obviously, $HOME/.hkexsh_id on both server and client $HOME for the user entering a password (obviously, $HOME/.hkexsh_id on both server and client for the user
should *not* be world-readable.) should *not* be world-readable.)
File Copying using hkexcp File Copying using hkexcp
@ -121,10 +136,10 @@ remote user. File operations are all performed as the remote user, so account pe
as expected. as expected.
Local (client) to remote (server) copy: Local (client) to remote (server) copy:
* cd hkexsh && ./hkexcp fileA /some/where/fileB /some/where/else/dirC joebloggs@host-or-ip:remoteDir * hkexcp fileA /some/where/fileB /some/where/else/dirC joebloggs@host-or-ip:remoteDir
Remote (server) to local (client) copy: Remote (server) to local (client) copy:
* cd hekxsh && ./hkexcp joebloggs@host-or-ip:/remoteDirOrFile /some/where/local/Dir * hkexcp joebloggs@host-or-ip:/remoteDirOrFile /some/where/local/Dir
NOTE: Renaming while copying is NOT supported (ie., like cp's 'cp /foo/bar/fileA ./fileB). NOTE: Renaming while copying is NOT supported (ie., like cp's 'cp /foo/bar/fileA ./fileB).
Put another way, the destination (whether local or remote) is ALWAYS a dir. Put another way, the destination (whether local or remote) is ALWAYS a dir.
@ -144,5 +159,5 @@ Syntax: hkexsh -T=<tunspec>{,<tunspec>...}
Example, tunnelling ssh through hkexsh Example, tunnelling ssh through hkexsh
* [server side] $ sudo /usr/sbin/sshd -p 7002 * [server side] $ sudo /usr/sbin/sshd -p 7002
* [client side] $ hkexsh -T=6002:7002 @server.hostname * [client side, term A] $ hkexsh -T=6002:7002 user@server
* [client side] $ ssh user@localhost -p 6002 * [client side, term B] $ ssh user@localhost -p 6002