README.rst 4.0 KB

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