From 1d27f304300f54b2d06813f36775329321e64c4f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sof=C3=ADa=20Celi?= <cherenkovd69@gmail.com>
Date: Sat, 18 May 2019 05:00:16 +0200
Subject: [PATCH] Improve readme

---
 README.md | 41 ++++++++++++++++++++++++++++++++---------
 1 file changed, 32 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 8d77fe7..4c59dcc 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ NOTE: This server is intended to be used only for local testing.
 
 ## Running the xmpp server on Docker
 
-1. Create an `.env` file with:
+1. Create an `.env` file that looks exactly like this:
 
 ```
   PREKEY_SERVER_IDENTITY=prekeys.localhost
@@ -21,6 +21,23 @@ NOTE: This server is intended to be used only for local testing.
 ```
 
 3. Copy the shown fingerprint (without spaces/brackets) into the `.env` file.
+   Something like this will be shown:
+
+```
+prekeys-raw_1   | Starting server on 0.0.0.0:30123...
+prekeys-raw_1   | [F91453A3D80BB48F FD683C98FBB2ED30 33F52861F6549F64 A45216627D43BA80 CCD9B08156CBAB97 E9B00314B313AF87 6FD6FBAFE97C00CC]
+prekeys-xmpp_1  | fingerprint provided is not valid
+```
+
+This is line shows you the appropriate fingerprint `prekeys-raw_1   | [F91453A3D80BB48F FD683C98FBB2ED30 33F52861F6549F64 A45216627D43BA80 CCD9B08156CBAB97 E9B00314B313AF87 6FD6FBAFE97C00CC]`.
+
+Copy it on the `.env` file, so it looks like this:
+
+```
+PREKEY_SERVER_IDENTITY=prekeys.localhost
+PREKEY_SERVER_FINGERPRINT=F91453A3D80BB48FFD683C98FBB2ED3033F52861F6549F64A45216627D43BA80CCD9B08156CBAB97E9B00314B313AF876FD6FBAFE97C00CC
+XMPP_COMPONENTS_SECRET=this is secret
+```
 
 4. Run:
 
@@ -28,33 +45,39 @@ NOTE: This server is intended to be used only for local testing.
 docker-compose up
 ```
 
-In another window do:
+Everything should run. This line should show up:
 
 ```
-docker-compose exec xmpp-server bash
-ls -al ~/localhost/
+xmpp-server_1   | prekeys.localhost:component  info	External component successfully authenticated
 ```
 
-We take the id/gid of the offline folder chown it outside of the docker container so the offline storage is writable.
+-------------------------------------------------------------------------------
+
+If you need to fix ownership issues, do:
 
+1. In another window do:
 
 ```
-sudo chown -R uid:gid prekey-server-docker-compose/prosody/data/localhost/
+docker-compose exec xmpp-server bash
+ls -al ~/localhost/
 ```
 
-5. Run:
+2. Take the id/gid of the offline folder chown it outside of the docker container so the offline storage is writable.
 
 ```
-  docker-compose up
+sudo chown -R uid:gid prekey-server-docker-compose/prosody/data/localhost/
 ```
 
+-------------------------------------------------------------------------------
+
 In order to make this server be recognizable by the pidgin plugin, you need to:
 
 ```
   ./configure CFLAGS="-ggdb3 -O0 -DDEFAULT_PREKEYS_SERVER='\"prekeys.localhost\"'"
 ```
 
-## Accounts
+## Accounts available
+
 ```
 user                password
 alice@localhost     alice
-- 
GitLab