Added web.allowLuceneIndexing to enable/disable Lucene integration

2 files changed, 9 insertions, 3 deletions

diff --git a/docs/01_setup.mkd b/docs/01_setup.mkd
index 09ddabbd..c5d78def 100644
--- a/docs/01_setup.mkd
+++ b/docs/01_setup.mkd
@@ -385,11 +385,11 @@ Repositories may optionally be indexed using the Lucene search engine.  The Luce
 

 ### How do I use it?

 

-Lucene indexing is an opt-in feature which means that no repositories are automatically indexed.  

+First you must ensure that *web.allowLuceneIndexing* is set *true* in `gitblit.properties` or `web.xml`.  Then you must understand that Lucene indexing is an opt-in feature which means that no repositories are automatically indexed.  

 Like anything else, this design has pros and cons.

 

 #### Pros

-1. no wasted cycles on repositories you will never search

+1. no wasted cycles indexing repositories you will never search

 2. you specify exactly what branches are indexed; experimental/dead/personal branches can be ignored

 

 #### Cons

@@ -408,6 +408,10 @@ You may specify which branches should be indexed per-repository in the *Edit Rep
 **NOTE:**  

 After specifying branches, only the content from those branches can be searched via Gitblit.  Gitblit will automatically redirect any queries entered on a repository's search box to the Lucene search page. Repositories that do not specify any indexed branches will use the traditional commit-traversal search.

 

+#### Adequate Heap

+

+The initial indexing of an existing repository can potentially exhaust the memory allocated to your Java instance and may throw OutOfMemory exceptions.  Be sure to provide your Gitblit server adequate heap space to index your repositories.  The heap is set using the *-Xmx* JVM parameter in your Gitblit launch command (e.g. -Xmx1024M).

+

 ## Client Setup and Configuration

 ### Https with Self-Signed Certificates

 You must tell Git/JGit not to verify the self-signed certificate in order to perform any remote Git operations.

diff --git a/docs/04_releases.mkd b/docs/04_releases.mkd
index 6e482103..5fec6e99 100644
--- a/docs/04_releases.mkd
+++ b/docs/04_releases.mkd
@@ -17,10 +17,12 @@
 #### additions

 

 - Added optional Lucene branch indexing (issue 16)  

+    **New:** *web.allowLuceneIndexing = true*  

     **New:** *web.luceneIgnoreExtensions = 7z arc arj bin bmp dll doc docx exe gif gz jar jpg lib lzh odg odf odt pdf ppt png so swf xcf xls xlsx zip*  

 Repository branches may be optionally indexed by Lucene for improved searching.  To use this feature you must specify which branches to index within the *Edit Repository* page; _no repositories are automatically indexed_.  Gitblit will build or incrementally update enrolled repositories on a 2 minute cycle. (i.e you will have to wait 2-3 minutes after respecifying indexed branches or pushing new commits before Gitblit will build/update the repository's Lucene index.)  

 If a repository has Lucene-indexed branches the *search* form on the repository pages will redirect to the root-level Lucene search page and only the content of those branches can be searched.  

-If the repository does not specify any indexed branches then repository commit-traversal search is used.

+If the repository does not specify any indexed branches then repository commit-traversal search is used.  

+**Note:** Initial indexing of an existing repository can be memory-exhaustive. Be sure to provide your Gitblit server adequate heap space to index your repositories (e.g. -Xmx1024M).

 - Allow specifying timezone to use for Gitblit which is independent of both the JVM and the system timezone (issue 54)  

     **New:** *web.timezone =*  

 - Added a built-in AJP connector for integrating Gitblit GO into an Apache mod_proxy setup (issue 59)