getting_started.rst 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. Getting Started
  2. ===============
  3. Selecting the right version
  4. ---------------------------
  5. Gluon's releases are managed using `Git tags`_. If you're a community getting
  6. started with Gluon we recommend to use the latest stable release if Gluon.
  7. Take a look at the `list of gluon releases`_ and notice the latest release,
  8. e.g. *v2014.3*.
  9. Please keep in mind that a matching site configuration for your community
  10. is required. Due to new features being added (or sometimes being removed)
  11. the format of the site configuration changes slightly between releases.
  12. Recent releases (starting with *v2014.3.1*) will come with an example
  13. configuration located in *docs/site-example/*.
  14. .. _Git tags: http://git-scm.com/book/en/Git-Basics-Tagging
  15. .. _list of gluon releases: https://github.com/freifunk-gluon/gluon/releases
  16. Building the image
  17. ------------------
  18. To build Gluon, first check out the repository. Replace *RELEASE* with the
  19. version you'd like to checkout, e.g. *v2014.3*.
  20. ::
  21. git clone https://github.com/freifunk-gluon/gluon.git gluon -b RELEASE
  22. This command will create a directory named *gluon/*.
  23. It might also tell a scary message about being in a *detached state*.
  24. **Don't panic!** Everything's fine.
  25. Now, enter the freshly created directory:
  26. ::
  27. cd gluon
  28. It's time to add (or create) your site configuration.
  29. So let's create the directory *site/*:
  30. ::
  31. mkdir site
  32. cd site
  33. Copy *site.conf* and *site.mk* from *docs/site-example*:
  34. ::
  35. cp ../docs/site-example/site.conf .
  36. cp ../docs/site-example/site.mk .
  37. .. note:: On **v2014.3**, take both files from
  38. https://github.com/freifunk-gluon/gluon/tree/2014.3.x/docs/site-example
  39. Edit both files to match your community, then go back to the top-level Gluon
  40. directory and build Gluon:
  41. ::
  42. cd ..
  43. make update # Get other repositories used by Gluon
  44. make # Build Gluon
  45. When calling make, the OpenWRT build environment is prepared/updated.
  46. In case of errors read the messages carefully and try to fix the stated issues (e.g. install tools not available yet).
  47. To rebuild the images only, just use:
  48. ::
  49. make images
  50. The built images can be found in the directory `images`. Of these, the factory
  51. images are to be used when flashing from the original firmware a device came with,
  52. and sysupgrade is to upgrade from other versions of Gluon or any other OpenWRT-based
  53. system.
  54. For the build reserve 6GB of disk space. The build requires packages
  55. for `subversion`, ncurses headers (`libncurses-dev`) and zlib headers
  56. (`libz-dev`).
  57. There are two levels of `make clean`:
  58. ::
  59. make clean
  60. will ensure all packages are rebuilt; this is what you normally want to do after an update.
  61. ::
  62. make dirclean
  63. will clean the entire tree, so the toolchain will be rebuilt as well, which is
  64. not necessary in most cases, and will take a while.
  65. Environment variables
  66. ---------------------
  67. Gluon's build process can be controlled by various environment variables.
  68. GLUON_SITEDIR
  69. Path to the site configuration. Defaults to ``site/``.
  70. GLUON_IMAGEDIR
  71. Path where images will be stored. Defaults to ``images/``.
  72. GLUON_BUILDDIR
  73. Working directory during build. Defaults to ``build/``.
  74. So all in all, to update and rebuild a Gluon build tree, the following commands should be used:
  75. ::
  76. git pull
  77. (cd site && git pull)
  78. make update
  79. make clean
  80. make