README.rst 4.3 KB

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