summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Batischev <eual.jp@gmail.com>2021-02-12 23:42:09 +0300
committerAlexander Batischev <eual.jp@gmail.com>2021-02-12 23:42:09 +0300
commit2d6cde78095be1760648f93713c976ed33d319bc (patch)
tree2b40b65be671110ada4f1fd238ca4a0cb23fba70 /README.md
parent627dbe11e861ece3b049789c435ef9e1ac7aa0af (diff)
downloadobnam2-2d6cde78095be1760648f93713c976ed33d319bc.tar.gz
doc(tutorial.md): add a rudimentary tutorial
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 3 insertions, 48 deletions
diff --git a/README.md b/README.md
index cba9db8..97c4484 100644
--- a/README.md
+++ b/README.md
@@ -2,54 +2,9 @@
Obnam2 is a project to develop a backup system.
-You probably want to read the [obnam.md](obnam.md) subplot file.
-
-## Client installation
-
-See instructions at <https://obnam.org/download/> for installing the
-client. It's not duplicated here to avoid having to keep the
-information in sync in two places.
-
-## Server installation
-
-To install the Obnam server component, you need a Debian host with
-sufficient disk space, and Ansible installed locally. Run the
-following commands in the Obnam source tree, replacing
-`obnam.example.com` with the domain name of your server:
-
-```sh
-$ cd ansible
-$ printf '[server]\nobnam.example.com\n' > hosts
-$ ansible-playbook -i hosts obnam-server.yml -e domain=obnam.example.com
-```
-
-The above gets a free TLS certificate from [Let's Encrypt][], but only
-works if the server is accessible from the public Internet. For a
-private host use the following instead:
-
-```sh
-$ cd ansible
-$ printf '[server]\nprivate-vm\n' > hosts
-$ ansible-playbook -i hosts obnam-server.yml
-```
-
-This uses a pre-created self-signed certificate from
-`files/server.key` and `files/server.pem` and is probably only good
-for trying out Obnam. You may want to generate your own certificates
-instead.
-
-To create a self-signed certificate, something like the following
-command might work, using [OpenSSL]:
-
-```sh
-$ openssl req -x509 -newkey rsa:4096 -passout pass:hunter2 \
- -keyout key.pem -out cert.pem -days 365 -subj /CN=localhost
-```
-
-
-[Let's Encrypt]: https://letsencrypt.org/
-[OpenSSL]: https://www.openssl.org/
-
+For installation instructions and a quick start guide, see
+[tutorial.md](tutorial.md). For more details on goals, requirements, and
+implementation details, see the [obnam.md](obnam.md) subplot file.
## Legalese