$metadata->thumbnail_url is not guaranteed to be set

[quix0rs-gnu-social.git] / socialfy-your-domain / README.txt

diff --git a/socialfy-your-domain/README.txt b/socialfy-your-domain/README.txt
index ead4380f21af26a2b238e49071c165fc63ef71c5..b7691abe8d072b5a459fd5acbd4e87f0be7cb787 100644 (file)
--- a/socialfy-your-domain/README.txt
+++ b/socialfy-your-domain/README.txt
@@ -4,51 +4,45 @@ Initial simple way to Webfinger enable your domain -- needs PHP.
 Step 1
 ======
 
-First, put the folders 'xrd' and 'dot-well-known' on your website, so
-they load at:
+Put the 'dot-well-known' on your website, so it loads at:
 
-     http://yourname.com/xrd/
+     https://example.com/.well-known/
 
-     and
-
-     http://yourname.com/.well-known/
-
-     (Remember the . at the beginning of this one)
+(Remember the . at the beginning of this one, which is common practice
+for "hidden" files and why we have renamed it "dot-")
 
 Step 2
 ======
 
-Next, edit xrd/index.php and enter a secret in this line:
-
-$s = "";
-
-This can be anything you like...
-
-$s = "johnny-five";
-
-or 
-
-$s = "12345";
+Edit the .well-known/host-meta file and replace "example.com" with the
+domain name you're hosting the .well-known directory on.
 
-It really doesn't matter too much.
+Using vim you can do this as a quick method:
+    $ vim .well-known/host-meta [ENTER]
+    :%s/example.com/domain.com/    [ENTER]
+    :wq [ENTER]
 
 Step 3
 ======
 
 For each user on your site, and this might only be you...
 
-Make a copy of the example@example.com.xml file so that it's called...
+In the webfinger directory, make a copy of the example@example.com.xml file
+so that it's called (replace username and example.com with appropriate
+values, the domain name should be the same as you're "socialifying"):
 
-     yoursecretusername@domain.com.xml
+     username@example.com.xml
 
-     So, if your secret is 'johnny5' and your name is ben and your
-     domain is titanictoycorp.biz, your file should be called
-     johnny5ben@titanictoycorp.biz.xml
+Then edit the file contents, replacing "social.example.com" with your
+GNU social instance's base path, and change the user ID number (and
+nickname for the FOAF link) to that of your account on your social
+site. If you don't know your user ID number, you can see this on your
+GNU social profile page by looking at the destination URLs in the
+Feeds links.
 
-Finally, edit the file to point at your account on your social
-site. If you are the only user, then you probably don't need to worry
-about user/1 as this will be you. For multi user sites, the user ID is
-on the profile page.
+PROTIP: You can get the bulk of the contents (note the <Subject> element though)
+        from curling down your real webfinger data:
+$ curl https://social.example.com/.well-known/webfinger?resource=acct:username@social.example.com
 
 Finally
 =======