Install / Update

Note: If Go is already installed, will use the currently installed version to install termbacktime. There is now an install script for Linux, Darwin, and Windows 10 using WSL. This will attempt to install the latest version of Go, defaulting back to 1.14. For other distributions please see the releases page. Go will be installed in $HOME/.goroot as $GOROOT and $GOPATH is set to $HOME/go.

curl -s -L https://termbackti.me/install.sh | bash

To install a different version of Go:

 wget https://termbackti.me/install.sh
 ./install.sh <version>

For example, 1.14.12 would be ./install.sh 1.14.12

If you already have Go installed, you can manually install:

go get -u louist.dev/termbacktime
cd $GOPATH/src/louist.dev/termbacktime
make install

Authorization

In order to submit recordings to Gist you must first authorize TermBackTime with GitHub. We request access to the read:user and gist scopes. For more information, please see available scopes. You can request an auth token from ~/auth or by running the following terminal command:

termbacktime auth

• GitHub authorization is NOT required for live terminal sharing.

Recording

After authorizing TermBackTime with GitHub simply run termbacktime record to start recording! Please see termbacktime --help for more options.

Live terminal sharing (BETA)

To start sharing your terminal over the web via WebRTC, simply run termbacktime live and give the provided link to someone. Please see termbacktime live --help for more options.

• This uses a broker server via WebSockets to handle signaling. Once the data channel via WebRTC is established the WebSocket connection is closed.

STUN options

For now TermBackTime uses Google’s STUN servers unless changed at compile time.

STUNServerOne = "stun:stun1.l.google.com:19302"
STUNServerTwo = "stun:stun2.l.google.com:19302"

A STUN server is used to detect network addresses. Please see https://en.wikipedia.org/wiki/STUN for more information.

TURN options

• Use an official TURN server provided by TermBackTime:
  • termbacktime live
• Provide your own TURN server credentials:
  • termbacktime live --turn <username>:<password>@<server>[:<port>]
  • termbacktime live --user <username> --password <password> --addr <server>[:<port>]
• Attempt to share without any TURN server:
  • termbacktime live --no-turn

A TURN server is used to relay WebRTC data between clients. Please see https://webrtc.org/getting-started/turn-server for more information.

Development

You can build your own development builds via make build-dev or make build-crosscompile-dev. I provide development server endpoints for playback + live terminal, login, and WebRTC signaling at:

• dev.termbackti.me
• dev-login.termbackti.me
• dev-api.termbackti.me
• dev-broker.termbackti.me

Please note that these endpoints are under active development and may change or be unavailable at any time.