git-annex/doc/index.mdwn

[[!inline raw=yes pages="summary"]]

To get a feel for git-annex, see the [[walkthrough]] or read about [[how_it_works]].

[[!sidebar content="""
[[!img logo_small.png link=no]]

* **[[install]]**
* [[assistant]]
* [[tips]]
* [[bugs]]
* [[todo]]
* [[forum]]
* [[comments]]
* [[contact]]
* [[testimonials]]
* <a href="http://flattr.com/thing/84843/git-annex"><img src="https://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" /></a>

[[News]]:

<small>
[[!inline pages="news/* and !*/discussion" archive=yes show=3 feeds=no]]
</small>

[[Feeds]]:

<small>
[[!inline pages="internal(feeds/*)" archive=yes show=8 feeds=no]]
</small>
"""]]

<table>
<tr>
<td width="50%" valign="top">[[!inline feeds=no template=bare pages=use_case/bob]]</td>
<td width="50%" valign="top">[[!inline feeds=no template=bare pages=use_case/alice]]</td>
</tr>
</table>

If that describes you, or if you're some from column A and some from column
B, then git-annex may be the tool you've been looking for to expand from
keeping all your small important files in git, to managing your large
files with git.

## documentation

* [[git-annex man page|git-annex]]
* [[key-value backends|backends]] for data storage
* [[special_remotes]] (including [[special_remotes/S3]] and [[special_remotes/bup]])
* [[sync]]
* [[encryption]]
* [[bare_repositories]]
* [[direct_mode]]
* [[internals]]
* [[scalability]]
* [[design]]
* [[what git annex is not|not]]
* [[sitemap]]

## talks

<video controls src="http://video.fosdem.org/2012/lightningtalks/git_annex___manage_files_with_git,_without_checking_their_contents_into_git.webm" width="500"></video>  
A [15 minute introduction to git-annex](http://video.fosdem.org/2012/lightningtalks/git_annex___manage_files_with_git,_without_checking_their_contents_into_git.webm), presented by Richard Hartmann.

<br clear="all" />

----

git-annex is [[Free Software|license]]

git-annex's wiki is powered by [Ikiwiki](http://ikiwiki.info/) and
hosted by [Branchable](http://branchable.com/).
split out summary and inline raw 2011-03-06 16:22:56 +00:00			`[[!inline raw=yes pages="summary"]]`
add doc wiki 2010-10-19 18:37:19 +00:00
link to assistant in summary and sidebar 2012-08-27 18:55:54 +00:00			`To get a feel for git-annex, see the [[walkthrough]] or read about [[how_it_works]].`
add walkthrough 2010-10-20 00:07:50 +00:00
update 2010-10-19 23:28:29 +00:00			`[[!sidebar content="""`
no link 2010-11-14 01:37:47 +00:00			`[[!img logo_small.png link=no]]`
add logo 2010-11-14 01:29:30 +00:00
remove download link from sidebar; install link is the key one 2012-09-29 00:58:01 +00:00			`* [[install]]`
link to assistant in summary and sidebar 2012-08-27 18:55:54 +00:00			`* [[assistant]]`
add link 2011-10-17 18:28:30 +00:00			`* [[tips]]`
add doc wiki 2010-10-19 18:37:19 +00:00			`* [[bugs]]`
reorg 2010-10-25 15:47:45 +00:00			`* [[todo]]`
link forum 2010-11-14 18:08:20 +00:00			`* [[forum]]`
add comments page 2011-03-16 03:25:16 +00:00			`* [[comments]]`
add doc wiki 2010-10-19 18:37:19 +00:00			`* [[contact]]`
link 2012-04-13 19:38:37 +00:00			`* [[testimonials]]`
fix broken img 2011-07-24 13:15:43 +00:00			`* <a href="http://flattr.com/thing/84843/git-annex"><img src="https://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" /></a>`
flattr button 2010-11-16 22:00:42 +00:00
add news to sidebar 2010-12-09 15:36:10 +00:00			`[[News]]:`

smaller 2011-03-31 20:08:25 +00:00			`<small>`
layout 2011-03-31 20:10:17 +00:00			`[[!inline pages="news/* and !*/discussion" archive=yes show=3 feeds=no]]`
smaller 2011-03-31 20:08:25 +00:00			`</small>`
add news to sidebar 2010-12-09 15:36:10 +00:00
add feeds to sidebar 2011-03-31 20:02:36 +00:00			`[[Feeds]]:`

fix 2011-03-31 20:09:12 +00:00			`<small>`
room for a few more feed items 2012-04-05 18:53:53 +00:00			`[[!inline pages="internal(feeds/*)" archive=yes show=8 feeds=no]]`
smaller 2011-03-31 20:08:25 +00:00			`</small>`
layout 2011-03-31 20:05:51 +00:00			`"""]]`
add feeds to sidebar 2011-03-31 20:02:36 +00:00
update 2010-10-19 23:28:29 +00:00			`<table>`
			`<tr>`
format 2011-03-04 17:04:49 +00:00			`<td width="50%" valign="top">[[!inline feeds=no template=bare pages=use_case/bob]]</td>`
			`<td width="50%" valign="top">[[!inline feeds=no template=bare pages=use_case/alice]]</td>`
update 2010-10-19 23:28:29 +00:00			`</tr>`
			`</table>`

			`If that describes you, or if you're some from column A and some from column`
			`B, then git-annex may be the tool you've been looking for to expand from`
			`keeping all your small important files in git, to managing your large`
			`files with git.`
add doc wiki 2010-10-19 18:37:19 +00:00
update 2010-10-19 19:59:40 +00:00			`## documentation`

update 2010-10-19 20:07:33 +00:00			`* [[git-annex man page\|git-annex]]`
update 2010-10-19 19:59:40 +00:00			`* [[key-value backends\|backends]] for data storage`
added documentation for using the Internet Archive as a remote via S3 Renamed Amazon_S3 page to just S3. 2011-05-16 06:07:59 +00:00			`* [[special_remotes]] (including [[special_remotes/S3]] and [[special_remotes/bup]])`
add a sync page documenting sync in detail 2011-12-31 00:02:55 +00:00			`* [[sync]]`
link 2011-04-17 15:45:34 +00:00			`* [[encryption]]`
fix up commands that are trouble on bare repos Most will just abort. init does a basic init and gives a command to run elsewhere to finish it. 2011-03-03 20:40:55 +00:00			`* [[bare_repositories]]`
link to direct_mode 2012-12-13 20:09:33 +00:00			`* [[direct_mode]]`
link 2011-04-09 17:10:01 +00:00			`* [[internals]]`
add scalability page 2012-02-14 22:50:25 +00:00			`* [[scalability]]`
move 2011-04-03 19:53:40 +00:00			`* [[design]]`
update 2010-10-19 23:28:29 +00:00			`* [[what git annex is not\|not]]`
add sitemap 2012-01-04 01:12:01 +00:00			`* [[sitemap]]`
update 2010-10-19 19:59:40 +00:00
layout 2012-02-14 21:27:13 +00:00			`## talks`

			`<video controls src="http://video.fosdem.org/2012/lightningtalks/git_annex___manage_files_with_git,_without_checking_their_contents_into_git.webm" width="500"></video>`
			`A [15 minute introduction to git-annex](http://video.fosdem.org/2012/lightningtalks/git_annex___manage_files_with_git,_without_checking_their_contents_into_git.webm), presented by Richard Hartmann.`

layout 2011-03-31 20:10:17 +00:00			`<br clear="all" />`
add doc wiki 2010-10-19 18:37:19 +00:00
layout 2011-03-31 20:11:00 +00:00			`----`

license the webapp under the AGPL 3+ This means that anyone serving up the webapp to users as a service (ie, without providing any git-annex binary at all to the user) still needs to provide a link to the source code for it, including any modifications they may make. This may make git-annex be covered by the AGPL as a whole when it is built with the webapp. If in doubt, you should ask a lawyer. When git-annex is built with the webapp disabled, no AGPLed code is used. Even building in the assistant does not pull in AGPLed code. 2012-09-24 18:48:47 +00:00			`git-annex is [[Free Software\|license]]`
add sitemap 2012-01-04 01:12:01 +00:00
add doc wiki 2010-10-19 18:37:19 +00:00			`git-annex's wiki is powered by [Ikiwiki](http://ikiwiki.info/) and`
			`hosted by [Branchable](http://branchable.com/).`