tech-support is the terminal side of Remote Support. It opens a support session, or joins the one already open, so an Awesome-O support engineer can reach the device. It is the same session as on the web interface’s Device → Remote support page: you can start it in one place and end it in the other.
If you only want to open a support session, the Remote Support page is the simpler way. It also explains what the engineer can do and what Awesome-O receives during a session.
Where to run it: open Device → Terminal in the web interface, or connect over SSH. The command asks for your password, because it runs with
sudo. If support is helping with a network problem, the web interface’s Terminal page is the more reliable place, because it does not depend on your SSH connection.
tech-support [--reason "…"] [--contact "…"]
--reason: what you need help with (up to 2,000 characters). Without it, the command asks for one.--contact: how support can reach you (optional, up to 200 characters).The command opens the session, shows its details, then waits:
$ tech-support --reason "Bouncer on the office firewall stopped reading decisions"
…
Press enter to end session and clean up tech support…
(will also end automatically when the operator resolves the ticket)
Press Enter to end the session. It also ends by itself if the support engineer closes the ticket, or if someone ends it on the Remote support page. Then it prints Remote support session ended.
Each of these does one thing and returns at once:
| Command | What it does |
|---|---|
tech-support start [--reason "…"] [--contact "…"] |
Open a session (or join the open one) without waiting |
tech-support stop |
End the open session |
tech-support status [--json] |
Show the open session: ticket, status, when it opened, tunnel address, engineer account and reason. Prints No active support session. when there is none |
tech-support note --text "…" |
Add a note to the session’s ticket |
tech-support reboot |
Restart the device and resume the session when it is back (the same as Reboot and resume on the web page). Internet traffic through the device stops while it restarts |
An unknown command exits with code 2; a failure exits with code 1 and says why.
When the session ends, by any of the ways above, the device stops the support container, deletes the tunnel settings and the engineer’s account, and tells the support server.
No inbound ports need to be opened on your firewall. See the outbound ports on the Requirements page.
do-tech-support service. tech-support is only a front end to it.| Path | Role |
|---|---|
/usr/local/sbin/tech-support |
The command (a link to /usr/sbin/awesome-o-tech-support) |
/usr/sbin/do-tech-support and do-tech-support.service |
The service that runs the session |
do-tech-support-resume.service |
Resumes a session after Reboot and resume |
/etc/awesome-o/tech-support.conf |
Settings (support server paths, state folder, resume window) |
/var/lib/awesome-o-tech-support/ |
The open session’s state |
/etc/nftables.d/support-acl.nft |
The outbound ports the support tunnel and chat may use |