]> git.netwichtig.de Git - user/henk/code/shell/rif.git/blobdiff - README.md
Update all files to use RI6F instead of RIF
[user/henk/code/shell/rif.git] / README.md
index 7b1f35944df4e4d76181d236dc6b3640714ca85c..5cab12ac04497023f2a79844a7763b82674441f0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,8 +22,8 @@ just connect to their computer!
 It's a bit geeky, but it works actually rather simple.
 To become a real IPv6 friend, you need to do the following things:
 
-- Generate a GPG key with a comment named **RIF** following the URL of
-  your computer (f.i. **RIF https://nico.ungleich.cloud**)
+- Generate a GPG key with a comment named **RI6F** following the URL of
+  your computer (f.i. **RI6F https://nico.ungleich.cloud**)
 - Ensure that the URL points to the IPv6 address of your computer
 - Setup a webserver on your computer
 - Export your key and all real IPv6 friend keys to your webserver as
@@ -31,6 +31,7 @@ To become a real IPv6 friend, you need to do the following things:
 - For each of your friends, check whether they are online
 - Import the friends of your friends and check whether they are
   online, too!
+- Send friend requests (like other platforms!)
 
 ### Example: Generating a key with the right comment
 
@@ -78,9 +79,9 @@ Is this correct? (y/N) y
 GnuPG needs to construct a user ID to identify your key.
 
 Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? c
-Comment: RIF https://nico.ungleich.cloud
+Comment: RI6F https://nico.ungleich.cloud
 You selected this USER-ID:
-    "Nico Schottelius (RIF https://nico.ungleich.cloud) <ipv6@nico.ungleich.cloud>"
+    "Nico Schottelius (RI6F https://nico.ungleich.cloud) <ipv6@nico.ungleich.cloud>"
 
 Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o
 We need to generate a lot of random bytes. It is a good idea to perform
@@ -98,7 +99,7 @@ public and secret key created and signed.
 
 pub   ed25519 2019-09-09 [SC]
       B982A8BABC030C66DEF5984527541E11E73F288D
-uid                      Nico Schottelius (RIF https://nico.ungleich.cloud) <ipv6@nico.ungleich.cloud>
+uid                      Nico Schottelius (RI6F https://nico.ungleich.cloud) <ipv6@nico.ungleich.cloud>
 sub   cv25519 2019-09-09 [E]
 
 
@@ -119,7 +120,7 @@ sudo chown $(whoami) /var/www/html
 To make yourself accessible and expose who your real IPv6 friends are.
 
 ```
-gpg -a --export RIF > /var/www/html/rifkeys
+gpg -a --export RI6F > /var/www/html/rifkeys
 ```
 
 ### Example: List your friends
@@ -127,9 +128,9 @@ gpg -a --export RIF > /var/www/html/rifkeys
 You can use the included rif-listfriends.sh or directly gpg:
 
 ```
-[1:40] line:~% gpg --list-keys --with-colons | grep RIF | awk -F: '{ print $10 }' | sed 's/\\x3a/:/'
-Nico Schottelius (RIF https://nico.ungleich.cloud) <ipv6@nico.ungleich.cloud>
-Nico Schottelius (myself) (RIF https://nico2.ungleich.cloud) <nico@nico.ungleich.cloud>
+[1:40] line:~% gpg --list-keys --with-colons | grep RI6F | awk -F: '{ print $10 }' | sed 's/\\x3a/:/'
+Nico Schottelius (RI6F https://nico.ungleich.cloud) <ipv6@nico.ungleich.cloud>
+Nico Schottelius (myself) (RI6F https://nico2.ungleich.cloud) <nico@nico.ungleich.cloud>
 ```
 
 
@@ -174,7 +175,7 @@ In any case, to update your friend list, simply repeat the command you
 ran above already in the beginning:
 
 ```
-gpg -a --export RIF > /var/www/html/rifkeys
+gpg -a --export RI6F > /var/www/html/rifkeys
 ```
 
 Or use the included `rif-exportfriends.sh`
@@ -196,6 +197,21 @@ automates this process.
 You can probably just use your mail program for that - and you might
 even be able to send it IPv6 only!
 
+### Example: Invite a friend
+
+Live is not great without friends! Let's invite a friend! This is as
+easy is this:
+
+```
+printf 'Hello yournamehere!\n I am looking for real IPv6 friends.\n You find my friends on https://nico.ungleich.cloud/rifkeys.\nHow real IPv6 friends find each other is explained on https://code.ungleich.ch/nico/rif.\n Looking forward to befriend you!' | mail -s "friend request" ipv6@your.friend.example.com
+```
+
+And obviously this is waaaaaaaaay to long to type. That's why
+`rif-invitefriends.sh` puts this nicely into a script.
+
+Attention: this requires a working mail setup on your computer
+(i.e. outgoing emails sending by `mail` works).
+
 ## Finding friends
 
 As real IPv6 friends are decentralised, there is no central registry