From 18c8e7ef9497226259bace59c4a2c13376d04962 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 22 Dec 2020 08:57:04 +0200 Subject: add download page --- download.mdwn | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 download.mdwn diff --git a/download.mdwn b/download.mdwn new file mode 100644 index 0000000..1202e3f --- /dev/null +++ b/download.mdwn @@ -0,0 +1,95 @@ +[[!meta title="Download and install"]] + +## Source code + +Obnam source code is distributed via the git version control system. +There are two repositories, which are intended to be identical: + +* GitLab: +* git.liw.fi: + +Use either according to preference. + +## Build and install from source + +Obnam is written in the [Rust language](https://www.rust-lang.org/), +and you need the Rust toolchain and the `cargo` tool installed. If you +have that installed and configured, you can build and install Obnam +from source as follows: + +~~~sh +git clone https://gitlab.com/larswirzenius/obnam +cd obnam +cargo build +cargo install --path=. +~~~ + +The `debian/control` file lists the necessary packages under the +`Depends` and `Build-Depends` headings. + +## Debian + +There is a Debian package built by CI from every commit. It works on +Debian 10 (buster) and later. We have a script to install it: + +~~~sh +curl -s https://gitlab.com/larswirzenius/obnam/-/raw/main/install-debian.sh | sudo bash +~~~ + +If you'd rather not download a script from the Internet and run it as +root (kudos!), you can do the same steps manually. Add the following +to `/etc/apt/sources.list.d/obnam.list`: + +~~~ +deb http://ci-prod-controller.vm.liw.fi/debian unstable-ci main +~~~ + +Then save the following PGP public key as +`/etc/apt/trusted.gpg.d/obnam.asc`: + +~~~ +-----BEGIN PGP PUBLIC KEY BLOCK----- + +mQINBFrLO7kBEADdz6mHstYmKU5Dp6OSjxWtWaqTDOX1sJdmmaIK/9EKVIH0Maxp +5kvVO5G6mULLAjv/kLG0MxasHPrq8I2A/y8AqKAGVL8QelwLjQMIFZ30/VbGQPHS ++T5TZXEnoQtNce1GUhFwJ38ZyjjwHBFV9tSec7rZ2Q3YeM3nNnGPf6DacXGfEOPO +HIN4sXAN2hzNXNjKRzTIvxQseb6nr7afUh/SlZ3yhQOCrIzmYlD7tP9WJe7ofL0p +JY4pDQYw8rT6nC2BE/ioemh84kERCT1vCe+OVFlSRuMlqfEv+ZpKQ+itOmPDQ/lM +jpUm1K2hrW/lWpxT/ZxHKo/w1K36J5WshgMZxfUu5BMCL9LMqMcrXNhNjDMfxDMM +3yBPOvQ4ls6fecOZ/bsFo1p8VzMk/w/eG8vPs5yuNa5XxN95yFMXoOHGb5Xbu8D4 +6yiW+Af70LbiSNpGdmNdneiGB2fY38NxBukPw5u3S5qG8HedSmMr1RvSr5kHoAAe +UbOY+BYaaKsTAT7+1skUW1o3FJSqoRKCHAzTsMWC6zzhR8hRn7jVrrguH1hGbqq5 +TZSCFQZExuTJ7uXrTLG0WoBXIjB5wWNcSeXn8myUWYB51nJNF4tJBouZOz9JwWGl +kiAQkrHnBttLQWdW9FyjbIoTZMtpvVx+m6ObGTGdGL1cNlLAvWprMXGc+QARAQAB +tDJJY2sgQVBUIHJlcG9zaXRvcnkgc2lnbmluZyBrZXkgKDIwMTgpIDxsaXdAbGl3 +LmZpPokCTgQTAQgAOBYhBKL1uyDoXyxUH3O717Wr+TZVS6PGBQJayzu5AhsDBQsJ +CAcCBhUICQoLAgQWAgMBAh4BAheAAAoJELWr+TZVS6PGB5QQANTcikhRUHwt9N4h +dGc/Hp6CbqdshMoWlwpFskttoVDxQG5OAobuZl5XyzGcmja1lT85RGkZFfbca0IZ +LnXOLLSAu51QBkXNaj4OhjK/0uQ+ITrvL6RQSXNgHiUTR/W2XD1GIUq6nBqe2GSN +31S1baYKKVj5QIMsi7Dq8ls3BBXuPCE+xTSaNmGWjes2t9pPidcRvxsksCLY1qgw +P1GFXBeMkBQ29kBP87SUL15SIk7OiQLlEURCy5iRls5rt/YEsdEpRWIb0Tm5Nrjv +2M3VM+iBhfNXTwj0rJ34mlycF1qQmA7YcTEobT7z587GPY0VWzBpQUnEQj7rQWPM +cDYY0b+I6kQ8VKOaL4wVAtE98d7HzFIrIrwhTKufnrWrVDPYsmLZ+LPC1jiF7JBD +SR6Vftb+SdDR9xoE1yRuXbC6IfoW+5/qQNrdQ2mm9BFw5jOonBqchs18HTTf3441 +6SWwP9fY3Vi+IZphPPi0Gf85oMStgnv/Wnw6LacEL32ek39Desero/D8iGLZernK +Q2mC9mua5A/bYGVhsNWyURNFkKdbFa+/wW3NfdKYyZnsSfo+jJ2luNewrhAY7Kod +GWXTer9RxzTGA3EXFGvNr+BBOOxSj0SfWTl0Olo7J5dnxof+jLAUS1VHpceHGHps +GSJSdir7NkZidgwoCPA7BTqsb5LN +=dXB0 +-----END PGP PUBLIC KEY BLOCK----- +~~~ + + +After that run the following commands to install Obnam: + +~~~sh +apt update +apt install obnam +~~~ + +## Other systems + +The Obnam developers all use Debian on the 64-bit Intel +architecture, and don't provide installation packages for other kinds +of systems (other architectures, other operating systems). If you'd +like to help with that, it would be very much welcome! -- cgit v1.2.1 From cf4d1985c5a61ab51f1eef1dcd0a042aa2820701 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 22 Dec 2020 08:59:58 +0200 Subject: add contact page --- contact.mdwn | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 contact.mdwn diff --git a/contact.mdwn b/contact.mdwn new file mode 100644 index 0000000..68ad387 --- /dev/null +++ b/contact.mdwn @@ -0,0 +1,9 @@ +[[!meta title="Contact"]] + +The Obnam project does not yet have a mailing list, IRC channel, Matrix +room, or other online presence except this website. You can reach its +members by emailing them directly. + +* Lars: + * mail: `liw@liw.fi` + * IRC: `liw` on the OFTC network -- cgit v1.2.1 From 69fc9e3a3b08b1a11a0beb7a94eae258aebcf1b9 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 22 Dec 2020 09:03:10 +0200 Subject: add license page --- license.mdwn | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 license.mdwn diff --git a/license.mdwn b/license.mdwn new file mode 100644 index 0000000..60ca308 --- /dev/null +++ b/license.mdwn @@ -0,0 +1,6 @@ +[[!meta title="Licenses"]] + +[GNU General Public Licence, version 3 or later]: https://www.gnu.org/licenses/gpl-3.0.html + +Obnam is licensed under the [GNU General Public License, version +3 or later][]. -- cgit v1.2.1 From 295502efcba2c9de07740ff70c703c65dbd1526a Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 22 Dec 2020 09:00:14 +0200 Subject: rearrange things on front page, add "menu bar" at top --- index.mdwn | 10 +++++++--- license.mdwn | 5 ++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/index.mdwn b/index.mdwn index 869997e..dd55bf4 100644 --- a/index.mdwn +++ b/index.mdwn @@ -1,5 +1,10 @@ [[!meta title="Obnam - backup software"]] +[[Download]] — +[[Documentation|https://doc.obnam.org/]] — +[[Contact]] — +[[License]] + [[!img kitten.jpg class="float_right" link="https://commons.wikimedia.org/wiki/File:A_focused_kitten_(Pixabay).jpg" alt="Kitten being adorable. By Ty Swartz, CC0, via Wikimedia Commons"]] @@ -12,9 +17,6 @@ It is currently not ready to be used, but do check in later. See This web site used to be about Obnam1, the original version that was retired in 2017. All that content has been dropped now. -Obnam2 acceptance criteria are documented using [Subplot][], and are -on [docs.obnam.org](https://doc.obnam.org/). - **25-word summary of the new architecture:** client splits live data into chunks, then compresses and encrypts them, and uploads new ones to smart server via HTTP; server never sees cleartext. @@ -26,6 +28,8 @@ Links * [Source code (gitlab.com)](https://gitlab.com/larswirzenius/obnam) ([mirror](http://git.liw.fi/obnam2)) * [[Road map|roadmap]] for developing Obnam. +* Acceptance criteria are documented using [Subplot][], and are on + [docs.obnam.org](https://doc.obnam.org/). * [Obnam blog posts](https://blog.liw.fi/tag/obnam/) * Other backup software: * [Borg](https://www.borgbackup.org/) diff --git a/license.mdwn b/license.mdwn index 60ca308..0e1e353 100644 --- a/license.mdwn +++ b/license.mdwn @@ -1,6 +1,5 @@ [[!meta title="Licenses"]] -[GNU General Public Licence, version 3 or later]: https://www.gnu.org/licenses/gpl-3.0.html +[GNU General Public License, version 3 or later]: https://www.gnu.org/licenses/gpl-3.0.html -Obnam is licensed under the [GNU General Public License, version -3 or later][]. +Obnam is licensed under the [GNU General Public License, version 3 or later][]. -- cgit v1.2.1