From a004081b913c1bcf50184ee76df00bf889965d98 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 21 Mar 2012 18:04:34 -0400
Subject: [PATCH] Documentation
---
docs/01_setup.mkd | 32 +++++++++++++++++++++++---------
1 files changed, 23 insertions(+), 9 deletions(-)
diff --git a/docs/01_setup.mkd b/docs/01_setup.mkd
index 624ef53..51921e0 100644
--- a/docs/01_setup.mkd
+++ b/docs/01_setup.mkd
@@ -86,6 +86,7 @@
--useNio Use NIO Connector else use Socket Connector.
--httpPort HTTP port for to serve. (port <= 0 will disable this connector)
--httpsPort HTTPS port to serve. (port <= 0 will disable this connector)
+ --ajpPort AJP port to serve. (port <= 0 will disable this connector)
--storePassword Password for SSL (https) keystore.
--shutdownPort Port for Shutdown Monitor to listen on. (port <= 0 will disable this monitor)
--tempFolder Folder for server to extract built-in webapp
@@ -140,19 +141,15 @@
Allow from all
</Proxy>
-# Turn on Proxy status reporting at /status
-# This should be better protected than: Allow from all
-ProxyStatus On
-<Location /status>
- SetHandler server-status
- Order Deny,Allow
- Allow from all
-</Location>
-
# The proxy context path must match the Gitblit context path.
# For Gitblit GO, see server.contextPath in gitblit.properties.
#ProxyPass /gitblit http://localhost:8080/gitblit
+#ProxyPassreverse /gitblit http://localhost:8080/gitblit
+
+# If your httpd frontend is https but you are proxying http Gitblit WAR or GO
+#Header edit Location ^http://([^/]+)/gitblit/ https://$1/gitblit/
+
#ProxyPass /gitblit ajp://localhost:8009/gitblit
%ENDCODE%
**Please** make sure to:
@@ -375,6 +372,23 @@
**NOTE:**
Care should be taken when devising your notification scheme as it relates to any VIEW restricted repositories you might have. Setting a global mailing list and activating push notifications for a VIEW restricted repository may send unwanted emails.
+## Lucene Search Integration
+
+*SINCE 0.9.0*
+
+Repositories may optionally be indexed using the Lucene search engine. Lucene indexing is an opt-in feature which means that no repositories are automatically indexed. Like anything else, this has benefits and drawbacks.
+
+You may specify which branches should be indexed per-repository in the *Edit Repository* page. New/empty repositories can not pre-specify indexed branches; you can only specify indexed branches for a repository with commits. Indexes are built and incrementally updated on a 2 minute cycle so you may have to wait a few minutes before your index is built or before your latest pushes get indexed.
+
+**NOTE:**
+Repositories that specify indexed branches will redirect to the Lucene search page from the search box in the upper right corner of a repository page. Repositories that do not specify any indexed branches will use the traditional commit search.
+
+The Lucene search offers several advantages over the traditional commit search:
+
+1. multi-term searches
+2. term-highlighted and syntax-highlighted fragment matches
+3. multi-repository searches
+
## 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.
--
Gitblit v1.9.1