diff --git a/README.md b/README.md index ef6c442..69f08bc 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,24 @@ # Go web terminal +- the app runs with access as user who started it! - it runs on https ( default is random ssl certifcate generated during start) - you can turn off user account required to access it during startup - default user account is `ivor` and pw `Silv3rSw0rd!` ## Usage: -`./gotermix -addr ` - - listen address (default "127.0.0.1:5000") -`./gotermix -nopw` - - disable password authentication -`./gotermix -setlogin ` - - set login username (next arg is password) and restart the app. -`./gotermix -cert /etc/ssl/my.crt -certkey /etc/ssl/my.key` - -s et a cert (validates it first, then stores paths encrypted, exits) -`./gotermix -cert /etc/ssl/combined.pem` - - combined cert+key PEM file (omit -certkey) -`./gotermix -certreset` - - remove stored cert, revert to self-signed + +- listen address (default "127.0.0.1:5000") + `./gotermix -addr ` +- disable password authentication + `./gotermix -nopw` +- set login username (next arg is password) and restart the app. + `./gotermix -setlogin ` +-s et a cert (validates it first, then stores paths encrypted, exits) + `./gotermix -cert /etc/ssl/my.crt -certkey /etc/ssl/my.key` +- combined cert+key PEM file (omit -certkey) + `./gotermix -cert /etc/ssl/combined.pem` +- remove stored cert, revert to self-signed + `./gotermix -certreset` ## Set custom encryption password for the .json file during build `export GOTERMINAL_ENC="SoMeStRongPasSwoR2d"`