topaLE
/
wetty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
366 Commits
2 Branches
19 Tags
3.8 MiB
Tree: e2e5a24771
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e2e5a24771'
${ noResults }
wetty/docs/flags.md

39 lines
1.2 KiB
Raw Normal View History

Feature/remediation (#162) clean up server package to be for ogranised No longer use event emitting for logging ensure process env is typed correctly remove 301 redirect reenable text on mobile split static classes up to make repo more structured split docs up Add List of contributors Docs: Add @butlerx as a contributor Docs: Add @krishnasrinivas as a contributor Docs: Add @acalatrava as a contributor Docs: Add @Strubbl as a contributor Docs: Add @2sheds as a contributor Docs: Add @rabchev as a contributor Docs: Add @nosemeocurrenada as a contributor Docs: Add @lucamilanesio as a contributor Docs: Add @antonyjim as a contributor Docs: Add @mirtouf as a contributor Docs: Add @CoRfr as a contributor Docs: Add @benletchford as a contributor Docs: Add @SouraDutta as a contributor Docs: Add @koushikmln as a contributor Docs: Add @imuli as a contributor Docs: Add @perpen as a contributor Docs: Add @nathanleclaire as a contributor Docs: Add @MiKr13 as a contributor Docs: Add @cardil as a contributor Docs: Add @fbartels as a contributor Docs: Add @jarrettgilliam as a contributor Docs: Add @harryleesan as a contributor Docs: Add @inducer as a contributor Docs: Add @DenisKramer as a contributor Docs: Add @vamship as a contributor Docs: Add @tnguyen14 as a contributor Docs: Add @pojntfx as a contributor Docs: Add @nealey as a contributor Docs: Add @mtpiercey as a contributor Docs: Add @kholbekj as a contributor Docs: Add @khanzf as a contributor Docs: Add @jurruh as a contributor Docs: Add @jamtur01 as a contributor
5 years ago
# Flags
WeTTy can be run with the `--help` flag to get a full list of flags.
## Server Port
WeTTy runs on port `3000` by default. You can change the default port by
starting with the `--port` or `-p` flag.
## SSH Host
If WeTTy is run as root while the host is set as the local machine it will use
the `login` binary rather than ssh. If no host is specified it will use
`localhost` as the ssh host.
If instead you wish to connect to a remote host you can specify the host with
update docs for v2
4 years ago
the `--ssh-host` flag and pass the IP or DNS address of the host you want to
Feature/remediation (#162) clean up server package to be for ogranised No longer use event emitting for logging ensure process env is typed correctly remove 301 redirect reenable text on mobile split static classes up to make repo more structured split docs up Add List of contributors Docs: Add @butlerx as a contributor Docs: Add @krishnasrinivas as a contributor Docs: Add @acalatrava as a contributor Docs: Add @Strubbl as a contributor Docs: Add @2sheds as a contributor Docs: Add @rabchev as a contributor Docs: Add @nosemeocurrenada as a contributor Docs: Add @lucamilanesio as a contributor Docs: Add @antonyjim as a contributor Docs: Add @mirtouf as a contributor Docs: Add @CoRfr as a contributor Docs: Add @benletchford as a contributor Docs: Add @SouraDutta as a contributor Docs: Add @koushikmln as a contributor Docs: Add @imuli as a contributor Docs: Add @perpen as a contributor Docs: Add @nathanleclaire as a contributor Docs: Add @MiKr13 as a contributor Docs: Add @cardil as a contributor Docs: Add @fbartels as a contributor Docs: Add @jarrettgilliam as a contributor Docs: Add @harryleesan as a contributor Docs: Add @inducer as a contributor Docs: Add @DenisKramer as a contributor Docs: Add @vamship as a contributor Docs: Add @tnguyen14 as a contributor Docs: Add @pojntfx as a contributor Docs: Add @nealey as a contributor Docs: Add @mtpiercey as a contributor Docs: Add @kholbekj as a contributor Docs: Add @khanzf as a contributor Docs: Add @jurruh as a contributor Docs: Add @jamtur01 as a contributor
5 years ago
connect to.
## Default User
update docs for v2
4 years ago
You can specify the default user used to ssh to a host using the `--ssh-user`.
Feature/remediation (#162) clean up server package to be for ogranised No longer use event emitting for logging ensure process env is typed correctly remove 301 redirect reenable text on mobile split static classes up to make repo more structured split docs up Add List of contributors Docs: Add @butlerx as a contributor Docs: Add @krishnasrinivas as a contributor Docs: Add @acalatrava as a contributor Docs: Add @Strubbl as a contributor Docs: Add @2sheds as a contributor Docs: Add @rabchev as a contributor Docs: Add @nosemeocurrenada as a contributor Docs: Add @lucamilanesio as a contributor Docs: Add @antonyjim as a contributor Docs: Add @mirtouf as a contributor Docs: Add @CoRfr as a contributor Docs: Add @benletchford as a contributor Docs: Add @SouraDutta as a contributor Docs: Add @koushikmln as a contributor Docs: Add @imuli as a contributor Docs: Add @perpen as a contributor Docs: Add @nathanleclaire as a contributor Docs: Add @MiKr13 as a contributor Docs: Add @cardil as a contributor Docs: Add @fbartels as a contributor Docs: Add @jarrettgilliam as a contributor Docs: Add @harryleesan as a contributor Docs: Add @inducer as a contributor Docs: Add @DenisKramer as a contributor Docs: Add @vamship as a contributor Docs: Add @tnguyen14 as a contributor Docs: Add @pojntfx as a contributor Docs: Add @nealey as a contributor Docs: Add @mtpiercey as a contributor Docs: Add @kholbekj as a contributor Docs: Add @khanzf as a contributor Docs: Add @jurruh as a contributor Docs: Add @jamtur01 as a contributor
5 years ago
This user can overwritten by going to
`http://yourserver:3000/wetty/ssh/<username>`. If this is left blank a user will
be prompted to enter their username when they connect.
## SSH Port
By default WeTTy will try to ssh to port `22`, if your host uses an alternative
update docs for v2
4 years ago
ssh port this can be specified with the flag `--ssh-port`.
Feature/remediation (#162) clean up server package to be for ogranised No longer use event emitting for logging ensure process env is typed correctly remove 301 redirect reenable text on mobile split static classes up to make repo more structured split docs up Add List of contributors Docs: Add @butlerx as a contributor Docs: Add @krishnasrinivas as a contributor Docs: Add @acalatrava as a contributor Docs: Add @Strubbl as a contributor Docs: Add @2sheds as a contributor Docs: Add @rabchev as a contributor Docs: Add @nosemeocurrenada as a contributor Docs: Add @lucamilanesio as a contributor Docs: Add @antonyjim as a contributor Docs: Add @mirtouf as a contributor Docs: Add @CoRfr as a contributor Docs: Add @benletchford as a contributor Docs: Add @SouraDutta as a contributor Docs: Add @koushikmln as a contributor Docs: Add @imuli as a contributor Docs: Add @perpen as a contributor Docs: Add @nathanleclaire as a contributor Docs: Add @MiKr13 as a contributor Docs: Add @cardil as a contributor Docs: Add @fbartels as a contributor Docs: Add @jarrettgilliam as a contributor Docs: Add @harryleesan as a contributor Docs: Add @inducer as a contributor Docs: Add @DenisKramer as a contributor Docs: Add @vamship as a contributor Docs: Add @tnguyen14 as a contributor Docs: Add @pojntfx as a contributor Docs: Add @nealey as a contributor Docs: Add @mtpiercey as a contributor Docs: Add @kholbekj as a contributor Docs: Add @khanzf as a contributor Docs: Add @jurruh as a contributor Docs: Add @jamtur01 as a contributor
5 years ago
## WeTTy URL
If you'd prefer an HTTP base prefix other than `/wetty`, you can specify that
with `--base`.
**Do not set this to `/ssh/${something}`, as this will break username matching
code.**