README.rst
68 lines
| 3.0 KiB
| text/x-rst
|
RstLexer
| r254 | ------------------------------------- | ||
| r253 | Pylons based replacement for hgwebdir | ||
| r254 | ------------------------------------- | ||
| r253 | |||
| Fully customizable, with authentication, permissions. Based on vcs library. | |||
| r254 | |||
| **Overview** | |||
| - has it's own middleware to handle mercurial protocol request each request can | |||
| r253 | be logged and authenticated + threaded performance unlikely to hgweb | ||
| r325 | - full permissions per project read/write/admin access even on mercurial request | ||
| r392 | - mako templates let's you cusmotize look and feel of application. | ||
| r253 | - diffs annotations and source code all colored by pygments. | ||
| r498 | - mercurial branch graph and yui-flot powered graphs with zooming | ||
| r253 | - admin interface for performing user/permission managments as well as repository | ||
| r392 | managment. | ||
| r498 | - full text search of source codes with indexing daemons using whoosh | ||
| (no external search servers required all in one application) | |||
| - async tasks for speed and performance using celery (works without them too) | |||
| r402 | - Additional settings for mercurial web, (hooks editable from admin | ||
| panel !) also manage paths, archive, remote messages | |||
| r325 | - backup scripts can do backup of whole app and send it over scp to desired location | ||
| r290 | - setup project descriptions and info inside built in db for easy, non | ||
| file-system operations | |||
| r253 | - added cache with invalidation on push/repo managment for high performance and | ||
| r392 | always upto date data. | ||
| r402 | - rss / atom feeds, gravatar support | ||
| r253 | - based on pylons 1.0 / sqlalchemy 0.6 | ||
| r254 | **Incoming** | ||
| r253 | |||
| r325 | - code review based on hg-review (when it's stable) | ||
| r498 | - git support (when vcs can handle it - almost there !) | ||
| - commit based wikis | |||
| - in server forks | |||
| - clonning from remote repositories into hg-app | |||
| - other cools stuff that i can figure out (or You can help me figure out) | |||
| r253 | |||
| .. note:: | |||
| r392 | This software is still in beta mode. | ||
| I don't guarantee that it'll work correctly. | |||
| r253 | |||
| ------------- | |||
| Installation | |||
| ------------- | |||
| r325 | .. note:: | ||
| I recomend to install tip version of vcs while the app is in beta mode. | |||
| r327 | - create new virtualenv and activate it - highly recommend that you use separate | ||
| virtual-env for whole application | |||
| r498 | - download hg app from default branch from bitbucket and run | ||
| r325 | 'python setup.py install' this will install all required dependencies needed | ||
| r327 | - run paster setup-app production.ini it should create all needed tables | ||
| r498 | and an admin account make sure You specify correct path to repositories. | ||
| r344 | - remember that the given path for mercurial repositories must be write | ||
| r327 | accessible for the application | ||
| - run paster serve development.ini - or you can use manage-hg_app script. | |||
| r254 | the app should be available at the 127.0.0.1:5000 | ||
| r325 | - use admin account you created to login. | ||
| - default permissions on each repository is read, and owner is admin. So remember | |||
| r402 | to update these. | ||
| r498 | - in order to use full power of async tasks, You must install message broker | ||
| preferrably rabbitmq and start celeryd daemon. The app should gain some speed | |||
| than. For installation instructions | |||
| You can visit: http://ask.github.com/celery/getting-started/index.html. All | |||
| needed configs are inside hg-app ie. celeryconfig.py | |||
| r325 |
