README.rst 4.0 KB

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