running.html 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. {
  2. title: "Running GoAhead",
  3. crumbs: [
  4. { "Getting Started": "../start/" },
  5. ],
  6. }
  7. <h1>Running GoAhead</h1>
  8. <p>GoAhead is built to listen on default ports specified at build time. These are typically set to port 80 for
  9. HTTP and port 443 for SSL. However, you can override these via GoAhead command line options. If <em>goahead</em> is invoked
  10. with an IP address or port number on the command line, GoAhead will listen on that IP address and not the
  11. default.</p>
  12. <p>The GoAhead command line usage is:</p>
  13. <pre class="ui code segment">
  14. goahead [options] [documents] [IP]:[PORT]
  15. </pre>
  16. <p>If the PORT component is omitted, GoAhead will listen on port 80. If the IP address is omitted and a port is
  17. supplied, GoAhead will listen on all network interfaces. An optional document root directory can be supplied for
  18. the location of the web pages.</p>
  19. <a id="goaheadOptions"></a>
  20. <h2>GoAhead Command Options</h2>
  21. <table title="options" class="ui table segment">
  22. <thead>
  23. <tr>
  24. <th class="three wide">Option</th>
  25. <th>Description</th>
  26. </tr>
  27. </thead>
  28. <tbody>
  29. <tr>
  30. <td>--auth filename</td>
  31. <td>Define the name of the authentication configuration file. This is by default auth.txt. If
  32. GoAhead is built with PAM support (Unix Pluggable Authentication Modules), then passwords will
  33. be authenticated from the system password database.</td>
  34. </tr>
  35. <tr>
  36. <td class="nowrap">--debugger</td>
  37. <td>Disable timeouts to make it easier to debug.</td>
  38. </tr>
  39. <tr>
  40. <td class="nowrap">--log logSpec</td>
  41. <td>Specify a file to log messages. This will override the ErrorLog directive in the
  42. configuration file. The logSpec syntax is logName[:logLevel]. When the maximum size
  43. is exceeded, the log file will be rotated to logName.old and a new log file will be started.
  44. The log level is a number between 0 and 9 where 0 is the least verbose. The -l option is an
  45. alias for --log.</td>
  46. </tr>
  47. <tr>
  48. <td class="nowrap">--home directory</td>
  49. <td>Specify the starting directory for the root of the server. This directory contains GoAhead
  50. configuration file.</td>
  51. </tr>
  52. <tr>
  53. <td class="nowrap">--route routeFile</td>
  54. <td>This option overrides the default route configuration file name of "route.txt". When
  55. GoAhead starts, it reads the route configuration file to load URI routes. These routes define
  56. what actions should be taken when various client requests are received.</td>
  57. </tr>
  58. <tr>
  59. <td>--verbose</td>
  60. <td>Shorthand for --log stderr:2. The -v option is an alias for --verbose.</td>
  61. </tr>
  62. <tr>
  63. <td>--version</td>
  64. <td>Display the goahead version number</td>
  65. </tr>
  66. </tbody>
  67. </table>