No Description

Chris Conner fc52eacc78 HUE-2731 [core] Hue collect data script didn't validate that Hue was running before trying to collect 10 years ago
apps c5281558e2 [oozie] Open Decision node EL help in another tab 10 years ago
desktop 6046fdafd4 Revert "HUE-2722 [beeswax] Revert default Thrift version to 5 instead of 7" 10 years ago
dist 252b5a19f6 [doc] Friendler tarball install README 10 years ago
docs 8b08bfc111 [doc] 3.8 release notes 10 years ago
ext 45d5510618 HUE-2436 [ext] Update the external dependency documentation 11 years ago
maven 236a004319 [core] Bump version to 3.8.1 10 years ago
tools fc52eacc78 HUE-2731 [core] Hue collect data script didn't validate that Hue was running before trying to collect 10 years ago
.gitattributes ae333e405b hue (formerly Cloudera Desktop) from internal commit 4694ac0434dad85170854c5378a389585d87f679 15 years ago
.gitignore ebe36238a9 [livy] Ignore the dependency-reduced-pom.xml 10 years ago
.jslintrc ae333e405b hue (formerly Cloudera Desktop) from internal commit 4694ac0434dad85170854c5378a389585d87f679 15 years ago
CONTRIBUTING.md 195e6ec3d3 [core] Adding link to contributing guidelines on github 11 years ago
LICENSE.txt ae333e405b hue (formerly Cloudera Desktop) from internal commit 4694ac0434dad85170854c5378a389585d87f679 15 years ago
Makefile d590fdbb00 [build] Fix the "make clean" order 10 years ago
Makefile.sdk 7ee080aec3 HUE-758 [core] Internationalization 13 years ago
Makefile.tarball b803b6ddf6 [build] Include the load-balancer in the tarball 10 years ago
Makefile.vars d590fdbb00 [build] Fix the "make clean" order 10 years ago
Makefile.vars.priv ae333e405b hue (formerly Cloudera Desktop) from internal commit 4694ac0434dad85170854c5378a389585d87f679 15 years ago
NOTICE.txt cea265d68a [core] Add third-party dependency references 11 years ago
README.rst 3d2d12bc92 [doc] Document we need make 10 years ago
VERSION 236a004319 [core] Bump version to 3.8.1 10 years ago
data db2e9f2f30 Make app registry location configurable 12 years ago

README.rst

.. image:: docs/images/hue_logo.png

Welcome to the repository for Hue
=================================

Hue is an open source Web interface for analyzing data with Apache Hadoop: `gethue.com
`_

.. image:: docs/images/hue-screen.png

It features:

* File Browser for accessing HDFS
* Hive Editor for developing and running Hive queries
* Search App for querying, exploring, visualizing data and dashboards with Solr
* Impala App for executing interactive SQL queries
* Spark Editor and Dashboard
* Pig Editor for submitting Pig scripts
* Oozie Editor and Dashboard for submitting and monitoring workflows, coordinators and bundles
* HBase Browser for visualizing, querying and modifying HBase tables
* Metastore Browser for accessing Hive metadata and HCatalog
* Job Browser for accessing MapReduce jobs (MR1/MR2-YARN)
* Job Designer for creating MapReduce/Streaming/Java jobs
* A Sqoop 2 Editor and Dashboard
* A ZooKeeper Browser and Editor
* A DB Query Editor for MySql, PostGres, Sqlite and Oracle

On top of that, a SDK is available for creating new apps integrated with Hadoop.

More user and developer documentation is available at http://gethue.com.


Getting Started
===============
To build and get the development server running::

$ git clone https://github.com/cloudera/hue.git
$ cd hue
$ make apps
$ build/env/bin/hue runserver

Now Hue should be running on http://localhost:8000 !

The configuration in development mode is ``desktop/conf/pseudo-distributed.ini``.


Note: to start the production server (but lose the automatic reloading after source modification)::

$ build/env/bin/supervisor

To run the tests::

Install the mini cluster (only once):
$ ./tools/jenkins/jenkins.sh slow

Run all the tests:
$ build/env/bin/hue test all

Or just some parts of the tests, e.g.:
$ build/env/bin/hue test specific impala
$ build/env/bin/hue test specific impala.tests:TestMockedImpala
$ build/env/bin/hue test specific impala.tests:TestMockedImpala.test_basic_flow


Development Prerequisites
===========================
You'll need these library development packages and tools installed on
your system:

Ubuntu:
* ant
* gcc
* g++
* libkrb5-dev
* libmysqlclient-dev
* libssl-dev
* libsasl2-dev
* libsasl2-modules-gssapi-mit
* libsqlite3-dev
* libtidy-0.99-0 (for unit tests only)
* libxml2-dev
* libxslt-dev
* make
* mvn (from ``maven`` package or maven3 tarball)
* openldap-dev / libldap2-dev
* python-dev
* python-setuptools

CentOS/RHEL:
* ant
* asciidoc
* cyrus-sasl-devel
* cyrus-sasl-gssapi
* gcc
* gcc-c++
* krb5-devel
* libtidy (for unit tests only)
* libxml2-devel
* libxslt-devel
* make
* mvn (from ``maven`` package or maven3 tarball)
* mysql
* mysql-devel
* openldap-devel
* python-devel
* sqlite-devel
* openssl-devel (for version 7+)

MacOS:
* Xcode command line tools
* Oracle's JDK 1.7+
* maven (Homebrew)
* mysql (Homebrew)


File Layout
===========
The Hue "framework" is in ``desktop``. ``/core/`` contains the Web components and
``desktop/libs/`` the API for talking to Hadoop.
The installable apps live in ``apps/``. Please place third-party dependencies in the app's ext-py/
directory.

The typical directory structure for inside an application includes:

src/
for Python/Django code
models.py
urls.py
views.py
forms.py
settings.py

conf/
for configuration (``.ini``) files to be installed

static/
for static HTML/js resources and help doc

templates/
for data to be put through a template engine

locales/
for localizations in multiple languages

For the URLs within your application, you should make your own ``urls.py``
which will be automatically rooted at ``/yourappname/`` in the global
namespace. See ``apps/about/src/about/urls.py`` for an example.


Main Stack
==========
Hue would not be possible without:

* Python 2.6.5 - 2.7
* Django 1.6 (https://docs.djangoproject.com/en/1.6/)
* Knockout.js (http://knockoutjs.com/)
* jQuery (http://jquery.com/)
* Bootstrap (http://getbootstrap.com/)


Community
=========
* User group: http://groups.google.com/a/cloudera.org/group/hue-user
* Jira: https://issues.cloudera.org/browse/HUE
* Reviews: https://review.cloudera.org/dashboard/?view=to-group&group=hue (repo 'hue-rw')


License
=======
Apache License, Version 2.0
http://www.apache.org/licenses/LICENSE-2.0