githubFork/gitblit.git - Solinfo Gitblit

			@@ -2,12 +2,14 @@

			SINCE 0.6.0

			A Gitblit federation is a mechanism to clone repositories and keep them in sync from one Gitblit instance to another. Federation can be used for automated backup of your repositories or may be used to initially clone groups of repositories to developer workstations. If you are/were a Subversion user you might think of this as [svn-sync](http://svnbook.red-bean.com/en/1.5/svn.ref.svnsync.html), but better.
			A Gitblit federation is a mechanism to clone repositories and keep them in sync from one Gitblit instance to another. Federation can be used to maintain a mirror of your Gitblit instance, to aggregate repositories from developer workstations, or to initially clone groups of repositories to developer workstations. If you are/were a Subversion user you might think of this as [svn-sync](http://svnbook.red-bean.com/en/1.5/svn.ref.svnsync.html), but better.

			If your Gitblit instance allows federation and it is properly registered with another Gitblit instance, each of the non-excluded repositories of your Gitblit instance can be mirrored, in their entirety, to the pulling Gitblit instance. You may optionally allow pulling of user accounts and backup of server settings.

			The federation feature should be considered a security backdoor and enabled or disabled as appropriate for your installation.<br/>
			Please review all the documentation to understand how it works and its limitations.

			![block diagram](fed_aggregation.png "Gitblit Federation Aggregation")

			### Origin Gitblit Instance Requirements

			@@ -37,7 +39,7 @@

			If you want your repositories (and optionally users accounts and settings) to be pulled by another Gitblit instance, you need to register your origin Gitblit instance with a pulling Gitblit instance by providing the url of your Gitblit instance and a federation token.

			Gitblit generates the following federation tokens:
			Gitblit generates the following standard federation tokens:
			%BEGINCODE%
			String allToken = SHA1(passphrase + "-ALL");
			String usersAndRepositoriesToken = SHA1(passphrase + "-USERS_AND_REPOSITORIES");
			@@ -52,9 +54,11 @@

			If federation.passphrase has a non-empty value, the federation tokens are displayed in the log file and are visible, to administrators, in the web ui.

			The three standard tokens grant access to ALL your non-excluded repositories. However, if you only want to specify different groups of repositories to be federated then you need to define federation sets.

			#### Federation Sets

			Federation Sets (federation.sets) are named groups of repositories. The Federation Sets are defined in `gitblit.properties` and are available for selection in the repository settings page. You can assign a repository to one or more sets and then distribute the token for the set. This allows you to grant federation pull access to a subset of your available repositories. Tokens for federation sets only grant pull access for the member repositories.
			Federation Sets (federation.sets) are named groups of repositories. The Federation Sets are defined in `gitblit.properties` and are available for selection in the repository settings page. You can assign a repository to one or more sets and then distribute the federation token for the set. This allows you to grant federation pull access to a subset of your available repositories. Tokens for federation sets only grant pull access for the member repositories.

			### Federation Proposals (Origin Gitblit Instance)

			@@ -91,7 +95,7 @@

			### Excluding Repositories (Origin Gitblit Instance)

			You may exclude a repository from being pulled by a federated Gitblit instance by setting its federation strategy to EXCLUDE in the repository's settings page.
			You may exclude a repository from being pulled by any federated Gitblit instance by setting its federation strategy to EXCLUDE in the repository's settings page.

			### Excluding Repositories (Pulling Gitblit Instance)

			@@ -234,6 +238,8 @@

			#### (Nearly) Perfect Mirror Example

			![block diagram](fed_mirror.png "Gitblit Mirror")

			This assumes that the token is the ALL token from the origin gitblit instance.

			The repositories, example1_users.properties, and example1_gitblit.properties will be put in git.repositoriesFolder and the origin user accounts will be merged into the local user accounts, including passwords and all roles. The Gitblit instance will also send a status acknowledgment to the origin Gitblit instance at the end of the pull operation. The status report will include the state of each repository pull (EXCLUDED, SKIPPED, NOCHANGE, PULLED, MIRRORED). This way the origin Gitblit instance can monitor the health of its mirrors.
			@@ -286,4 +292,25 @@
			federation.example4.bare = true
			federation.example4.mirror = true
			federation.example4.exclude = *
			federation.example4.include = somerepo.git
			federation.example4.include = somerepo.git

			## Federation Client

			Instead of setting up a full-blown pulling Gitblit instance, you can also use the [federation client](http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%) command-line utility. This is a packaged subset of the federation feature in a smaller, simpler command-line only tool.

			The federation client relies on many of the same dependencies as Gitblit and will download them on first execution.

			### federation.properties
			You may use the `federation.properties` file to configure one or more Gitblit instances that you want to pull from. This file is a subset of the standard `gitblit.properties` file.

			By default this tool does not daemonize itself; it executes and then quits. This allows you to use the native scheduling feature of your OS. Of course, if you'd rather use Gitblit's scheduler you may use that by specifying the `--daemon` parameter.

			### Command-Line Parameters
			Instead of using `federation.properties` you may directly specify a Gitblit instance to pull from with command-line parameters.

			java -jar fedclient.jar --url https://go.gitblit.com --mirror --bare --token 123456789
			--repositoriesFolder c:/mymirror

			java -jar fedclient.jar --url https://go.gitblit.com --mirror --bare --token 123456789
			--repositoriesFolder c:/mymirror --daemon --frequency "24 hours"