Make the README play nicer with rdoc
authorPete <pete@debu.gs>
Tue, 9 Jun 2020 23:26:01 +0000 (16:26 -0700)
committerPete <pete@debu.gs>
Tue, 9 Jun 2020 23:26:01 +0000 (16:26 -0700)
README

diff --git a/README b/README
index cf280813015ad8a9c411dbcc3bd9873ed4e8d2d8..f721515e8fe65736db0cc4e18176b6c2b94b032f 100644 (file)
--- a/README
+++ b/README
@@ -22,17 +22,17 @@ general as a result.
 
 [Check that your venti and Redis servers are operational.]
 
-$ sudo ed /etc/webvac.json
-a
-'{"server_path_prepend":"/where/uploads/get/put/in/the/filesystem"}'
-.
-wq
-$ sudo $EDITOR /etc/nginx/whatever
-[edit your nginx configuration to proxy requests for files to localhost:8891
-if the file doesn't exist]
-$ webvac-server -D
-$ find /where/uploads/get/put/in/the/filesystem -type f -print0 |
-  xargs -0 -n30 -P8 webvac-sweep -v -- 
+  $ sudo ed /etc/webvac.json
+  a
+  '{"server_path_prepend":"/where/uploads/get/put/in/the/filesystem"}'
+  .
+  wq
+  $ sudo $EDITOR /etc/nginx/whatever
+  [edit your nginx configuration to proxy requests for files to localhost:8891
+  if the file doesn't exist]
+  $ webvac-server -D
+  $ find /where/uploads/get/put/in/the/filesystem -type f -print0 |
+   xargs -0 -n30 -P8 webvac-sweep -v -- 
 [At this point, you should be able to rm the files in server_path_prepend to
 start serving them out of venti.  Big ones are slow for now.  
 
@@ -75,39 +75,39 @@ Here is an annotated list of configuration options, all of which start
 with their default values.  You will almost certainly need to change
 server_path_prepend.
 
-{
-  // A Redis connection string, one that Redic will take:
-  "redis_url": "redis://localhost:6379/0",
-
-  // These two options are used to turn the request path into a filesystem path.
-  // Watch this space, I might turn server_path_strip into an array.
-
-  // The beginning of the path that the entire server sits under; that is,
-  // what should be stripped from the front of the path.  For Pleroma, users'
-  // uploads are all under /media, so this works if you're serving uploads from
-  // https://$domain/media/$file .  You should probably not change this one for
-  // now, as Rake routes depend on it.
-  "server_path_strip": "/media",
-  // The beginning of the path in the *filesystem* that corresponds to where the
-  // files are kept.  It is *incredibly* unlikely that you are using the same
-  // path I am.
-  "server_path_prepend": "/media/block/fse",
-
-  // This is where the venti server is.  (This might be an array at some point.)
-  // This address is in dial(2) syntax, by the way, so $host:$port should be
-  // written tcp!$host!$port.  
-  "venti_server": "localhost",
-
-  // Where the vac and unvac binaries are kept:
-  "plan9bin": "/opt/plan9/bin",
-
-  // This is to make UGC work safely out of the box.  Hopefully no browser is
-  // dumb enough to run stuff inside <script> tags in something we're serving
-  // as text/plain:
-  "mime_substitutions": {
-    "text/html": "text/plain"
+  {
+    // A Redis connection string, one that Redic will take:
+    "redis_url": "redis://localhost:6379/0",
+
+    // These two options are used to turn the request path into a filesystem
+    // path.  Watch this space, I might turn server_path_strip into an array.
+
+    // The beginning of the path that the entire server sits under; that is,
+    // what should be stripped from the front of the path.  For Pleroma, users'
+    // uploads are all under /media, so this works if you're serving uploads from
+    // https://$domain/media/$file .  You should probably not change this one for
+    // now, as Rake routes depend on it.
+    "server_path_strip": "/media",
+    // The beginning of the path in the *filesystem* that corresponds to where
+    // the files are kept.  It is *incredibly* unlikely that you are using the
+    // same path I am.
+    "server_path_prepend": "/media/block/fse",
+
+    // This is where the venti server is.  (This might be an array at some
+    // point.)  This address is in dial(2) syntax, by the way, so $host:$port
+    // should be written "tcp!$host!$port".  
+    "venti_server": "localhost",
+
+    // Where the vac and unvac binaries are kept:
+    "plan9bin": "/opt/plan9/bin",
+
+    // This is to make UGC work safely out of the box.  Hopefully no browser is
+    // dumb enough to run stuff inside <script> tags in something we're serving
+    // as text/plain:
+    "mime_substitutions": {
+      "text/html": "text/plain"
+    }
   }
-}
 
 = Usage