goahead.1 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. .TH GOAHEAD "1" "March 2014" "goahead" "User Commands"
  2. .SH NAME
  3. goahead\- Embedded HTTP Web Server
  4. .SH SYNOPSIS
  5. .B goahead [options] [documents] [[IP][:port] ...]
  6. .P
  7. .B goahead
  8. \fB--auth authFile\fR
  9. \fB--background\fR
  10. \fB--debugger\fR
  11. \fB--home directory\fR
  12. \fB--log logSpec\fR
  13. \fB--route routeFile\fR
  14. \fB--version\fR
  15. \fB--verbose\fR
  16. \fB[IP][:port] [documents]\fR
  17. .SH DESCRIPTION
  18. GoAhead is popular, simple embedded HTTP web server. It is a fast, small-footprint, single-threaded, standards-based,
  19. portable server developed for use by embedded devices and applications. It can run as a stand-alone web server or the
  20. GoAhead library can be embedded in applications.
  21. .P
  22. GoAhead supports HTTP/1.1, SSL, digest, basic and web-form authentication, chunked transfers,
  23. file upload and sandbox security limits.
  24. .P
  25. When goahead is built, it is configured to open a port for HTTP requests and optionally one for SSL. However,
  26. if goahead is invoked with an IP address or port number on the command line, GoAhead will listen on these ports instead.
  27. If the PORT component is omitted, GoAhead will listen
  28. on port 80. If the IP address is omitted and a port is supplied, GoAhead will listen on all network interfaces.
  29. .SH OPTIONS
  30. .TP
  31. \fB\--auth filename\fR
  32. Define the name of the authentication configuration file. This is by default \fBauth.txt\fR.
  33. If GoAhead is built with PAM support (Unix Pluggable Authentication Modules), then passwords will be authenticated
  34. from the system password database.
  35. .TP
  36. \fB\--debugger\fR
  37. Run GoAhead in debug mode and disable all timeouts. This disables request and session timeouts.
  38. The \fB-d\fR option is an alias for --debugger.
  39. .TP
  40. \fB\--log logSpec\fR
  41. Name the GoAhead log file. This will override the ErrorLog directive
  42. in the configuration file. When the maximum size is exceeded, the log file will be rotated to logName.old
  43. and a new log file will be started. The \fB-l\fR option is an alias for --log.
  44. The syntax is:
  45. .PP
  46. .RS 6
  47. --log logName[:logLevel][.maxSize]
  48. .RE
  49. .TP
  50. \fB\--home directory\fR
  51. Define the server home directory for GoAhead.
  52. .TP
  53. \fB\--route routeFile\fR
  54. This option overrides the default route configuration file name of "route.txt". When GoAhead starts, it reads the
  55. route configuration file to load URI routes. These routes define what actions should be taken when various client
  56. requests are received.
  57. .TP
  58. \fB\--verbose\fR
  59. Shorthand for --log stdout:4. The \fB-v\fR option is an alias for --verbose.
  60. .TP
  61. \fB\--version\fR
  62. Output the product version number.
  63. .SH "REPORTING BUGS"
  64. Report bugs to <dev@embedthis.com>.
  65. .SH COPYRIGHT
  66. Copyright \(co Embedthis Software.
  67. .br
  68. .SH "SEE ALSO"
  69. gopass, webcomp