Documentation

James Moger

2012-03-27 0273b2905737e41babb0bfba7f4c33100bd40d68

Documentation

 docs/01_setup.mkd

@@ -393,17 +393,23 @@
2. you specify exactly what branches are indexed; experimental/dead/personal branches can be ignored



#### Cons

1. you have to opt-in a repository _after_ it is created and has some commits

2. you specify exactly what branches are indexed

1. you specify exactly what branches are indexed



#### Why does Gitblit check every 2 mins for repository/branch changes?

#### I have 300 repositories and you want me to specify indexed branches on each one??



Gitblit has to balance its design as a complete, integrated Git server and its utility as a repository viewer in an existing Git setup.

Yeah, I agree that is inconvenient.



Gitblit could build indexes immediately on *edit repository* or on *receiving pushes*, but that design would not work if someone is pushing via ssh://, git://, or file:// (i.e. not pushing to Gitblit http(s)://).  For this reason Gitblit has a polling mechanism to check for ref changes every 2 mins.  This design works well for all use cases, aside from adding a little lag in updating the index.

If you are using Gitblit GO there is a utility script `add-indexed-branch.cmd` which allows you to specify an indexed branch for many repositories in one step.



If you are using Gitblit WAR then, at present, you are out of luck unless you write your own script to traverse your repositories and use native Git to manipulate each repository config.



    git config --add gitblit.indexBranch "default"

    git config --add gitblit.indexBranch "refs/heads/master"



#### Indexing Branches

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.

You may specify which branches should be indexed per-repository in the *Edit Repository* page.  New/empty repositories may only specify the *default* branch which will resolve to whatever commit HEAD points to or the most recently updated branch if HEAD is unresolvable.



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:**  

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.

@@ -412,6 +418,12 @@


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).



#### Why does Gitblit check every 2 mins for repository/branch changes?



Gitblit has to balance its design as a complete, integrated Git server and its utility as a repository viewer in an existing Git setup.



Gitblit could build indexes immediately on *edit repository* or on *receiving pushes*, but that design would not work if someone is pushing via ssh://, git://, or file:// (i.e. not pushing to Gitblit http(s)://).  For this reason Gitblit has a polling mechanism to check for ref changes every 2 mins.  This design works well for all use cases, aside from adding a little lag in updating the index.



## 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.


 docs/04_releases.mkd

@@ -21,8 +21,9 @@
    **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.  
**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).

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).  
See the [setup](setup.html) page for additional details.

- 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)