summaryrefslogtreecommitdiff
path: root/index.mdwn
blob: 0f62df43a159524c85c4800536e0f3ecea2c2b46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
[[!meta title="Obnam - backup program"]]
[[!tag program]]

Obnam is starting over from scratch. See [blog
post](https://blog.liw.fi/posts/2020/10/16/obnam2_-_a_new_backup_system/).

Everything on this site is obsolete information and doesn't apply to
Obnam2. Obnam2 acceptance criteria are documented using [Subplot][],
and are on [docs.obnam.org](https://doc.obnam.org/).

[Subplot]: https://subplot.liw.fi/

This site will eventually be updated. Help is welcome.

-----------------------------------------------------------------------------

[[!img sticker.png alt="Obnam sticker" link=no class=sticker]]

Obnam is an **easy, secure backup program.**
Backups can be stored on local hard disks, 
or online via the 
[SSH SFTP](http://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol) protocol.
The backup server, if used, does not require any special software,
on top of SSH.

Some **features** that may interest you:

* **Snapshot** backups. Every generation looks like a complete snapshot,
  so you don't need to care about full versus incremental backups, or
  rotate real or virtual tapes.
* Data **de-duplication**, across files, and backup generations. If the
  backup repository already contains a particular chunk of data, it will
  be re-used, even if it was in another file in an older backup
  generation. This way, you don't need to worry about moving around large
  files, or modifying them. (However, the current implementation
  has some limitations: see [[faq/dedup]]).
* **Encrypted** backups, using GnuPG.

See the [[tutorial]], and below for links to the manual, which has
examples of how to use Obnam.

Obnam can do **push** or **pull** backups, depending on what you
need. You can run Obnam on the client, and push backups to the server,
or on the server, and pull from the client over SFTP. However, access
to live data over SFTP is currently somewhat limited and fragile, so it
is not recommended.

* [[1.0 release announcement|1.0]]
* [[Status and support|status]]
* [[Download]]
* [[Contact]]
* [[Bugs]]
* [[Donate]]

Documentation
-------------

* The full manual (currently a work in progress): available as:
    - [CI versions](http://code.liw.fi/obnam/manual/ci/), built from
      git, but not yet released, are also available.
    - The Obnam test suite is also meant to be useful for the more
      technical users of Obnam to read:
      [web page](http://code.liw.fi/obnam/yarns.html),
      [PDF](http://code.liw.fi/obnam/yarns.pdf).
    - See also manuals built automatically from version control
      by Jan Niggemann:
      <http://hz6.de/obnam-downloads/> 
* [README](http://git.liw.fi/cgi-bin/cgit/cgit.cgi/obnam/tree/README)
* [NEWS](http://git.liw.fi/cgi-bin/cgit/cgit.cgi/obnam/tree/NEWS)
* obnam manual page: 
  [English](http://code.liw.fi/obnam/obnam.1.txt),
  [German](http://code.liw.fi/obnam/obnam.1.de.txt).
* [[FAQ]]
* [[Development]] stuff

New repository format GREEN ALBATROSS
------------------------------------------------------------------------

A new repository format, [[format-green-albatross]], is being
developed. Its goal is to make Obnam faster than than it currently is.
See [[roadmap-ga]] for a rough roadmap finishing it.

Note that the main Obnam developer already uses GREEN ALBATROSS, but
incompatible on-disk format changes are still possible. If you use
GREEN ALBTROSS and a format change happens, you'll need to start over
with a new backup repository. Once the new repository format is
stable, backwards incompatible changes won't happen anymore. Also,
given very few people use GREEN ALBATROSS so far, it has a higher risk
of bugs than the default repository format. If you're curious, please
try GREEN ALBATROSS, but be aware of the risks.


Sponsored by Bytemark
---------------------

[[!img bytemark-ff3270c4.svg alt="Bytemark logo" link=no class=bytemark]]

Obnam development is partly sponsored by [Bytemark][] by providing
[BigV][] virtual machines for development and benchmarking.

[Bytemark]: https://www.bytemark.co.uk/r/liw
[BigV]: http://www.bigv.io/

Sponsored by the FUUG foundation
--------------------------------

The [FUUG foundation] gave a grant in September, 2015, for buying a
fast machine with lots of disk space for development and benchmarking
of Obnam.

[FUUG foundation]: http://fuug.fi/saatio/

Links
-----

* [Cache Directory Tagging Standard](http://www.bford.info/cachedir/)
* [Backup with obnam and encfs](http://sanskritfritz.wordpress.com/2014/04/24/backup-with-obnam-and-encfs/)