Add sample .gotty file

This commit is contained in:
Iwasaki Yudai 2015-08-30 06:48:45 +09:00
parent d3e48aa3ae
commit b821754e8a
2 changed files with 69 additions and 1 deletions

68
.gotty Normal file
View File

@ -0,0 +1,68 @@
// [string] Address to listen, all addresses will be used when empty
// address = ""
// [string] Port to listen
// port = "8080"
// [bool] Permit clients to write to the TTY
// permit_write = false
// [bool] Enable basic authentication
// enable_basic_auth = false
// [string] Default username and password of basic authentication (user:pass)
// To enable basic authentication, set `true` to `enable_basic_auth`
// credential = "user:pass"
// [bool] Enable random URL generation
// enable_random_url bool
// [int] Default length of random strings appended to URL
// To enable random URL generation, set `true` to `enable_random_url`
// random_url_length = 8
// [bool] Enable TLS/SSL
// enable_tls = false
// [string] Default TLS certificate file path
// tls_crt_file = "~/.gotty.crt"
// [string] Default TLS key file path
// tls_key_file = "~/.gotty.key"
// [string] Title format of browser window
// Available variables are:
// Command Command string
// Pid PID of the process for the client
// Hostname Server hostname
// RemoteAddr Client IP address
// title_format = "GoTTY - {{ .Command }} ({{ .Hostname }})"
// [bool] Enable client side reconnection when connection closed
// enable_reconnect = false
// [int] Interval time to try reconnection (seconds)
// To enable reconnection, set `true` to `enable_reconnect`
// reconnec_ttime = false
// [bool] Accept only one client and exit gotty once the client exits
// Once = false
// [object] Client terminal (hterm) preferences
// Examples below are some of commonly used options.
// See hterm's documentation for the complete list of preferences.
// https://chromium.googlesource.com/apps/libapps/+/master/hterm/js/hterm_preference_manager.js
// (Note that fihens `-` in preference names must be replaced by underscores `_`)
// preferences {
// background_color = "rgb(16, 16, 16)"
// background_image = ""
// cursor_blink = false
// cursor_color = "rgba(255, 0, 0, 0.5)"
// ctrl_c_copy = false
// ctrl_v_paste = false
// east_asian_ambiguous_as_two_column = false
// font_family = "'DejaVu Sans Mono', 'Everson Mono', 'FreeMono', 'Menlo', 'Terminal', monospace"
// font_size = 15
// foreground_color = "rgb(240, 240, 240)"
// user_css = ""
// }

View File

@ -87,7 +87,7 @@ preferences {
}
```
Available hterm preference options are listed in [the hterm source code](https://chromium.googlesource.com/apps/libapps/+/master/hterm/js/hterm_preference_manager.js). Note that hifens (`-`) in the preference names must be replaced by underscores (`_`).
See the [`.gotty`](https://github.com/yudai/gotty/.gotty) file in this repository for the list of configuration options.
### Security Options