README.rst 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. .. image:: docs/images/hue_logo.png
  2. Welcome to the repository for Hue
  3. =================================
  4. Hue is an open source Web interface for analyzing data with Apache Hadoop: `gethue.com
  5. <http://gethue.com>`_
  6. .. image:: docs/images/hue-screen.png
  7. It features:
  8. * File Browser for accessing HDFS
  9. * Hive Editor for developing and running Hive queries
  10. * Search App for querying, exploring, visualizing data and dashboards with Solr
  11. * Impala App for executing interactive SQL queries
  12. * Spark Editor and Dashboard
  13. * Pig Editor for submitting Pig scripts
  14. * Oozie Editor and Dashboard for submitting and monitoring workflows, coordinators and bundles
  15. * HBase Browser for visualizing, querying and modifying HBase tables
  16. * Metastore Browser for accessing Hive metadata and HCatalog
  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 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 development 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. Install the mini cluster (only once):
  37. $ ./tools/jenkins/jenkins.sh slow
  38. Run all the tests:
  39. $ build/env/bin/hue test all
  40. Or just some parts of the tests, e.g.:
  41. $ build/env/bin/hue test specific impala
  42. $ build/env/bin/hue test specific impala.tests:TestMockedImpala
  43. $ build/env/bin/hue test specific impala.tests:TestMockedImpala.test_basic_flow
  44. Development Prerequisites
  45. ===========================
  46. You'll need these library development packages and tools installed on
  47. your system:
  48. Ubuntu:
  49. * ant
  50. * gcc
  51. * g++
  52. * libkrb5-dev
  53. * libmysqlclient-dev
  54. * libssl-dev
  55. * libsasl2-dev
  56. * libsasl2-modules-gssapi-mit
  57. * libsqlite3-dev
  58. * libtidy-0.99-0 (for unit tests only)
  59. * libxml2-dev
  60. * libxslt-dev
  61. * mvn (from ``maven`` package or maven3 tarball)
  62. * openldap-dev / libldap2-dev
  63. * python-dev
  64. * python-setuptools
  65. CentOS/RHEL:
  66. * ant
  67. * asciidoc
  68. * cyrus-sasl-devel
  69. * cyrus-sasl-gssapi
  70. * gcc
  71. * gcc-c++
  72. * krb5-devel
  73. * libtidy (for unit tests only)
  74. * libxml2-devel
  75. * libxslt-devel
  76. * mvn (from ``maven`` package or maven3 tarball)
  77. * mysql
  78. * mysql-devel
  79. * openldap-devel
  80. * python-devel
  81. * sqlite-devel
  82. * openssl-devel (for version 7+)
  83. MacOS (mac port):
  84. * liblxml
  85. * libxml2
  86. * libxslt
  87. * mysql5-devel
  88. * sqlite3
  89. File Layout
  90. ===========
  91. The Hue "framework" is in ``desktop``. ``/core/`` contains the Web components and
  92. ``desktop/libs/`` the API for talking to Hadoop.
  93. The installable apps live in ``apps/``. Please place third-party dependencies in the app's ext-py/
  94. directory.
  95. The typical directory structure for inside an application includes:
  96. src/
  97. for Python/Django code
  98. models.py
  99. urls.py
  100. views.py
  101. forms.py
  102. settings.py
  103. conf/
  104. for configuration (``.ini``) files to be installed
  105. static/
  106. for static HTML/js resources and help doc
  107. templates/
  108. for data to be put through a template engine
  109. locales/
  110. for localizations in multiple languages
  111. For the URLs within your application, you should make your own ``urls.py``
  112. which will be automatically rooted at ``/yourappname/`` in the global
  113. namespace. See ``apps/about/src/about/urls.py`` for an example.
  114. Main Stack
  115. ==========
  116. Hue would not be possible without:
  117. * Python 2.6 - 2.7
  118. * Django 1.4 (https://docs.djangoproject.com/en/1.4/)
  119. * Knockout.js (http://knockoutjs.com/)
  120. * jQuery (http://jquery.com/)
  121. * Bootstrap (http://getbootstrap.com/)
  122. Community
  123. =========
  124. * User group: http://groups.google.com/a/cloudera.org/group/hue-user
  125. * Jira: https://issues.cloudera.org/browse/HUE
  126. * Reviews: https://review.cloudera.org/dashboard/?view=to-group&group=hue (repo 'hue-rw')
  127. License
  128. =======
  129. Apache License, Version 2.0
  130. http://www.apache.org/licenses/LICENSE-2.0