Adopt chain-loading properties as the default setup

4 files changed, 44 insertions, 7 deletions

diff --git a/src/site/setup_go.mkd b/src/site/setup_go.mkd
index 81172447..c46e04ba 100644
--- a/src/site/setup_go.mkd
+++ b/src/site/setup_go.mkd
@@ -1,7 +1,7 @@
 ## Gitblit GO Installation & Setup

 

 1. Download and unzip Gitblit GO [${project.releaseVersion} (Windows)](%GCURL%gitblit-${project.releaseVersion}.zip) or [${project.releaseVersion} (Linux/OSX)](%GCURL%gitblit-${project.releaseVersion}.tar.gz).  

-*Its best to eliminate spaces in the path name.* 

+*It is best to eliminate spaces in the path name.* 

 2. The server itself is configured through a simple text file.

 Open `data/gitblit.properties` in your favorite text editor and make sure to review and set:

     - *server.httpPort* and *server.httpsPort*

@@ -9,7 +9,7 @@ Open `data/gitblit.properties` in your favorite text editor and make sure to rev
     **https** is strongly recommended because passwords are insecurely transmitted form your browser/git client using Basic authentication!

     - *git.packedGitLimit* (set larger than the size of your largest repository)

 3. Execute `authority.cmd` or `java -cp gitblit.jar com.gitblit.authority.Launcher --baseFolder data` from a command-line

-**NOTE:** The Authority is a Swing GUI application.  Use of this tool is not required as Gitblit GO will startup and create SSL certificates itself, BUT use of this tool allows you to control the identification metadata used in the generated certificates.  Skipping this step will result in certificates with default metadata.

+**NOTE:** The Authority is a Swing GUI application.  Use of this tool is not required as Gitblit GO will startup and create SSL certificates itself, BUT use of this tool allows you to control the identification metadata used in the generated self-signed certificates.  Skipping this step will result in certificates with default metadata.

     1. fill out the fields in the *new certificate defaults* dialog

 	2. enter the store password used in *server.storePassword* when prompted.  This generates an SSL certificate for **localhost**.

 	3. you may want to generate an SSL certificate for the hostname or ip address hostnames you are serving from

@@ -30,6 +30,11 @@ If you are deploying Gitblit to a *nix platform, you might consider moving the d
 

 You can specify `GITBLIT_HOME` either as an environment variable or as a `-DGITBLIT_HOME` JVM system property.

 

+### Including Other Properties

+SINCE 1.7.0

+

+Gitblit supports loading it's settings from multiple properties files.  You can achieve this using the `include=filename` key.  This setting supports loading multiple files using a *comma* as the delimiter.  They are processed in the order defined and they may be nested (i.e. your included properties may include properties, etc, etc).

+

 ### Creating your own Self-Signed SSL Certificate

 Gitblit GO (and Gitblit Certificate Authority) automatically generates a Certificate Authority (CA) certificate and an ssl certificate signed by this CA certificate that is bound to *localhost*.

 

diff --git a/src/site/setup_war.mkd b/src/site/setup_war.mkd
index a060bae1..21492b2a 100644
--- a/src/site/setup_war.mkd
+++ b/src/site/setup_war.mkd
@@ -31,3 +31,8 @@ This is a better way to configure your *baseFolder* because it survives WAR rede
 

 1. Open TOMCAT_HOME/conf/context.xml

 2. Insert an *Environment* node within the *Context* node.<pre>&lt;Environment name="baseFolder" type="java.lang.String" value="c:/projects/git/gitblit/data" override="false" /&gt;</pre>

+

+### Including Other Properties

+SINCE 1.7.0

+

+Gitblit supports loading it's settings from multiple properties files.  You can achieve this using the `include=filename` key.  This setting supports loading multiple files using a *comma* as the delimiter.  They are processed in the order defined and they may be nested (i.e. your included properties may include properties, etc, etc).

diff --git a/src/site/upgrade_go.mkd b/src/site/upgrade_go.mkd
index 54d7ab59..a0092588 100644
--- a/src/site/upgrade_go.mkd
+++ b/src/site/upgrade_go.mkd
@@ -1,3 +1,17 @@
+## Upgrading Gitblit GO (1.7.0+)

+

+The default `gitblit.properties` file has been split into two files: `gitblit.properties`, which is the recommended file for setting your configuration, and `defaults.properties` which are Gitblit's default settings.

+

+    # Include Gitblit's 'defaults.properties' within your configuration.

+    #

+    # COMMA-DELIMITED

+    # SINCE 1.7.0

+    include = defaults.properties

+

+Notice that the default settings are *included* by your `gitblit.properties` file.  The disadvantage to this approach is you must flip between discovering/reading the settings in `defaults.properties` and setting them in `gitblit.properties`, but there are some clear advantages too.  This setup is not required.  You may continue to keep all your settings in `gitblit.properties` like before.

+

+Additionally you may find it useful if you are maintaining several Gitblit instances to share common properties files.

+

 ## Upgrading Gitblit GO (1.2.1+)

  

 1. Unzip Gitblit GO to a new folder

diff --git a/src/site/upgrade_war.mkd b/src/site/upgrade_war.mkd
index 34ffd758..4165ca10 100644
--- a/src/site/upgrade_war.mkd
+++ b/src/site/upgrade_war.mkd
@@ -1,3 +1,21 @@
+## Upgrading Gitblit WAR (1.7.0+)

+

+The default `gitblit.properties` file has been split into two files: `gitblit.properties`, which is the recommended file for setting your configuration, and `defaults.properties` which are Gitblit's default settings.

+

+    # Include Gitblit's 'defaults.properties' within your configuration.

+    #

+    # COMMA-DELIMITED

+    # SINCE 1.7.0

+    include = defaults.properties

+

+Notice that the default settings are *included* by your `gitblit.properties` file.  The disadvantage to this approach is you must flip between discovering/reading the settings in `defaults.properties` and setting them in `gitblit.properties`, but there are some clear advantages too.  This setup is not required.  You may continue to keep all your settings in `gitblit.properties` like before.

+

+Additionally you may find it useful if you are maintaining several Gitblit instances to share common properties files.

+

+## Upgrading Gitblit WAR (1.4.0+)

+

+The *baseFolder* context parameter has been replaced with a *baseFolder* JNDI env-entry.  This means you can define the *baseFolder* from the administrative console of your servlet container and not have to manipulate anything in the web.xml file.

+

 ## Upgrading Gitblit WAR (1.2.1+)

 1. Make sure your `WEB-INF/web.xml` *baseFolder* context parameter is not `${contextFolder}/WEB-INF/data`!

 If it is, move your `WEB-INF/data` folder to a location writeable by your servlet container.

@@ -5,7 +23,6 @@ If it is, move your `WEB-INF/data` folder to a location writeable by your servle
 3. Edit the new WAR's `WEB-INF/web.xml` file and set the *baseFolder* context parameter to your external baseFolder.

 4. Review and optionally apply any new settings as indicated in the [release log](releases.html) to `${baseFolder}/gitblit.properties`. 

  

-

 ## Upgrading Gitblit WAR (pre-1.2.1)

 

 1. Create a `data` as outlined in step 1 of *Upgrading Gitblit GO (pre-1.2.1)*

@@ -14,7 +31,3 @@ If it is, move your `WEB-INF/data` folder to a location writeable by your servle
 4. Copy the new WAR's `WEB-INF/data/gitblit.properties` file to your data folder

 5. Manually apply any changes you made to your original web.xml file to the gitblit.properties file you copied to your data folder

 6. Edit the new WAR's `WEB-INF/web.xml` file and set the *baseFolder* context parameter to your external baseFolder.

-

-## Upgrading Gitblit WAR (1.4.0+)

-

-The *baseFolder* context parameter has been replaced with a *baseFolder* JNDI env-entry.  This means you can define the *baseFolder* from the administrative console of your servlet container and not have to manipulate anything in the web.xml file.
\ No newline at end of file