README.rst 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. Welcome to the repository for Hue
  2. =================================
  3. .. note::
  4. This is the development-oriented readme. If you want to write notes for
  5. end users, please put them in ``dist/README``.
  6. Hue is both a Web UI for Hadoop and a framework to create interactive Web
  7. applications. It features:
  8. * FileBrowser for accessing HDFS
  9. * Job Designer for creating MapReduce/Streaming/Java jobs
  10. * Beeswax application for executing Hive queries
  11. * Impala App for executing Cloudera Impala queries
  12. * Oozie App for submitting and scheduling workflows and bundles
  13. * Pig App for submitting Pig scripts
  14. * Table Browser for accessing Hive metadata
  15. * JobBrowser for viewing MapReduce jobs
  16. * A Pig/HBase/Sqoop2 shell
  17. On top of that, a SDK is available for creating new apps integrated with Hadoop.
  18. More user and developer documentation is available at http://cloudera.github.com/hue/.
  19. Getting Started
  20. ===============
  21. To build and get the core server running::
  22. $ git clone http://github.com/cloudera/hue.git
  23. $ cd hue
  24. $ make apps
  25. $ build/env/bin/hue runserver
  26. If using the Beeswax application, start the daemon::
  27. $ build/env/bin/hue beeswax_server
  28. Now Hue should be running on http://localhost:8000.
  29. The configuration in development mode is ``desktop/conf/pseudo-distributed.ini``.
  30. Note: to start all the servers in one command (but lose the automatic reloading after source modification)::
  31. $ build/env/bin/supervisor
  32. To run the tests::
  33. $ build/env/bin/hue test all
  34. $ build/env/bin/hue test specific filebrowser
  35. $ build/env/bin/hue test specific jobbrowser.tests:test_get_path
  36. Development Prerequisites
  37. ===========================
  38. You'll need these library development packages and tools installed on
  39. your system:
  40. Ubuntu:
  41. * ant
  42. * gcc
  43. * g++
  44. * libkrb5-dev
  45. * libmysqlclient-dev
  46. * libssl-dev
  47. * libsasl2-dev
  48. * libsasl2-modules-gssapi-mit
  49. * libsqlite3-dev
  50. * libtidy-0.99-0 (for unit tests only)
  51. * libxml2-dev
  52. * libxslt-dev
  53. * mvn (from ``maven2`` package or tarball)
  54. * openldap-dev / libldap2-dev
  55. * python-dev
  56. * python-simplejson
  57. * python-setuptools
  58. CentOS:
  59. * ant
  60. * asciidoc
  61. * cyrus-sasl-devel
  62. * cyrus-sasl-gssapi
  63. * gcc
  64. * gcc-c++
  65. * krb5-devel
  66. * libtidy (for unit tests only)
  67. * libxml2-devel
  68. * libxslt-devel
  69. * mvn (from ``maven2`` package or tarball)
  70. * mysql
  71. * mysql-devel
  72. * openldap-devel
  73. * python-devel
  74. * python-simplejson
  75. * sqlite-devel
  76. MacOS (mac port):
  77. * liblxml
  78. * libxml2
  79. * libxslt
  80. * mysql5-devel
  81. * simplejson (easy_install)
  82. * sqlite3
  83. File Layout
  84. ===========
  85. The Hue "framework" is in ``desktop``. ``/core/`` contains the Web components and
  86. ``desktop/libs/`` the API for talking to Hadoop.
  87. The installable apps live in ``apps/``. Please place third-party dependencies in the app's ext-py/
  88. directory.
  89. The typical directory structure for inside an application includes:
  90. src/
  91. for Python/Django code
  92. models.py
  93. urls.py
  94. views.py
  95. forms.py
  96. settings.py
  97. conf/
  98. for configuration (``.ini``) files to be installed
  99. static/
  100. for static HTML/js resources and help doc
  101. templates/
  102. for data to be put through a template engine
  103. locales/
  104. for localizations in multiple languages
  105. For the URLs within your application, you should make your own ``urls.py``
  106. which will be automatically rooted at ``/yourappname/`` in the global
  107. namespace. See ``apps/about/src/about/urls.py`` for an example.
  108. Main Stack
  109. ==========
  110. * Python 2.4 - 2.7
  111. * Django 1.2 https://docs.djangoproject.com/en/1.2/
  112. * Mako
  113. * jQuery
  114. * Bootstrap
  115. Community
  116. =========
  117. * User group: http://groups.google.com/a/cloudera.org/group/hue-user
  118. * Jira: https://issues.cloudera.org/browse/HUE
  119. License
  120. =======
  121. Apache License, Version 2.0
  122. http://www.apache.org/licenses/LICENSE-2.0