James Moger
2015-12-08 f75535759570bbc4784ee8324b0d1b8dfb01766f
src/main/java/com/gitblit/wicket/pages/FilestoreUsage.html
@@ -12,16 +12,19 @@
<div class="span10 offset1">   
   
   <div class="alert alert-danger">
   <h3><center>Using the Filestore</center></h3>
   <h3><center>Using the filestore</center></h3>
   <p>
      <strong>All clients intending to use the filestore must first install the <a href="https://git-lfs.github.com/">Git-LFS Client</a> and then run <code>git lfs init</code> to register the hooks globally.</strong><br/>
      <i>This version of GitBlit has been verified with Git-LFS client version 0.6.0 which requires Git v1.8.2 or higher.</i>
      <strong>All clients intending to use the filestore must first install the <a href="https://git-lfs.github.com/">Git-LFS Client</a> and then run <code>git lfs install</code></strong><br/>
      <p>
      If using password authentication it is recommended that you configure the <a href="https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage">git credential storage</a> to avoid Git-LFS asking for your password on each file<br/>
      On Windows for example: <code>git config --global credential.helper wincred</code>
      </p>
   </p>
   </div>
      
   <h3>Clone</h3>
   <p>
   Just <code>git clone</code> as usual, no further action is required as GitBlit is configured to use the default Git-LFS end point <code>{repository}/info/lfs/objects/</code>.<br/>
   Just <code>git clone</code> as usual, no further action is required as Gitblit is configured to use the default Git-LFS end point <code>{repository}/info/lfs/objects/</code>.<br/>
   <i>If the repository uses a 3rd party Git-LFS server you will need to <a href="https://github.com/github/git-lfs/blob/master/docs/spec.md#the-server">manually configure the correct endpoints</a></i>.
   </p>
   
@@ -38,28 +41,7 @@
   <p><a href="https://github.com/github/git-lfs/blob/master/docs/spec.md">See the current Git-LFS specification for further details</a>.</p>
   <br />
   
   <div class="alert alert-warn">
   <h3><center>Limitations & Warnings</center></h3>
   <p>GitBlit currently provides a server-only implementation of the opensource Git-LFS API, <a href="https://github.com/github/git-lfs/wiki/Implementations">other implementations</a> are available.<br/>
   However, until <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=470333">JGit provides Git-LFS client capabilities</a> some GitBlit features may not be fully supported when using the filestore.
   Notably:
      <ul>
      <li>Mirroring a repository that uses Git-LFS - Only the pointer files, not the large files, are mirrored.</li>
      <li>Federation -  Only the pointer files, not the large files, are transfered.</li>
      </ul>
   </p>
   </div>
   <div class="alert alert-info">
   <h3><center>GitBlit Configuration</center></h3>
   <p>GitBlit provides the following configuration items when using the filestore:
      <h4>filestore.storageFolder</h4>
      <p>Defines the path on the server where filestore objects are to be saved. This defaults to <code>${baseFolder}/lfs</code></p>
      <h4>filestore.maxUploadSize</h4>
      <p>Defines the maximum allowable size that can be uploaded to the filestore.  Once a file is uploaded it will be unaffected by later changes in this property. This defaults to <code>-1</code> indicating no limits.</p>
   </p>
   </div>
</div>
</div>
</div>