releaseNotes.html 4.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. {
  2. title: "Release Notes",
  3. crumbs: [
  4. { 'Getting Started': '../start/' },
  5. ],
  6. }
  7. <h1>Release Notes</h1>
  8. <p>Welcome to the Embedthis GoAhead&trade; installation release notes. This document provides
  9. release-specific information for GoAhead. The release package the full source code, headers, documentation
  10. and samples for the GoAhead embedded web server.
  11. <a id="licensing"></a>
  12. <h2>License</h2>
  13. <p>This software is copyrighted and distributed under license. It is available under an open source
  14. license and an optional <a href="https://embedthis.com/licensing/">commercial license</a>.
  15. Please read LICENSE.md for details.</p>
  16. <p>GoAhead includes support for several external packages such as OpenSSL. These packages have their
  17. own licenses. Make sure you check the relevant package license details to ensure you are
  18. complying with their licenses.</p>
  19. <a id="requirements"></a>
  20. <h2>System Requirements</h2>
  21. <p>The following operating systems are be supported by compiling GoAhead from source.</p>
  22. <ul>
  23. <li>FreeBSD 1.X</li>
  24. <li>Linux 2.6</li>
  25. <li>MAC OS X 10.9 and later</li>
  26. <li>VxWorks 6.X</li>
  27. <li>Windows 7 and later</li>
  28. </ul>
  29. <p>The following CPU architectures are supported: arm, mips, ppc, xscale, x86, x64, sparc.</p>
  30. <p>The software has also been ported to other operating systems.</p>
  31. <h2>Run-time System Requirements</h2>
  32. <p>To deploy GoAhead in an embedded environment, you will need at least the following:</p>
  33. <ul>
  34. <li>500K - 1MB Disk / ROM space</li>
  35. <li>400K - 1MB RAM</li>
  36. </ul>
  37. <p>To install and build GoAhead from source on a development system, your system will need at
  38. least the following:</p>
  39. <ul>
  40. <li>60 MB Disk</li>
  41. <li>1GB MB RAM</li>
  42. </ul>
  43. <h2>Build and Tool Requirements</h2>
  44. <p>If you are building the software from source or using
  45. <a href="https://embedthis.com/expansive/">Expansive</a> to render web applications you may require:</p>
  46. <ul>
  47. <li><a href="https://embedthis.com/makeme/">MakeMe</a> version 0.8.6 or later to build with MakeMe.</li>
  48. <li><a href="https://embedthis.com/pak/">Pak</a> version 0.10.0 or later to install packages.</li>
  49. <li><a href="https://embedthis.com/expansive/">Expansive</a> version 0.5.0 or later to render
  50. web sites.</li>
  51. </ul>
  52. <h2>Development Environment</h2>
  53. <p>To compile GoAhead you will need to use a C compiler and associated
  54. development tools. Several development environments are supported. You may choose any of the following to
  55. compile and build samples and source code.</p>
  56. <ul>
  57. <li>Linux GNU tools</li>
  58. <li>Mac Xcode 6.4 and later.</li>
  59. <li>Windows Visual Studio 2013 and later.</li>
  60. <li>WindRiver Tornado Development Tools.</li>
  61. </ul>
  62. <a id="hints"></a>
  63. <h2>Helpful Hints</h2>
  64. <h3>Debug Trace and Logging</h3>
  65. <p>GoAhead has a debug logging and trace facility that can help when debugging configuration issues or
  66. developing your application code that uses GoAhead. You can vary the level of logging via the <b>--log
  67. logfile</b> command line switch for the <b>goahead</b> commands. The log command line switch has the
  68. format:</p>
  69. <pre class="ui code segment">
  70. goahead --log logFile:logLevel
  71. </pre>
  72. <p>Use the <em>-v</em> switch to trace to the standard output at level 2.</p>
  73. <pre class="ui code segment">
  74. goahead -v
  75. </pre>
  76. <p>The log level can be from 0 to 9, with 9 being the most verbose level.</p>