Browse Source

clean up config comments, fix postinstall. #124

jomo 10 years ago
parent
commit
20b6fd55aa
2 changed files with 11 additions and 11 deletions
  1. 10 10
      config.example.js
  2. 1 1
      package.json

+ 10 - 10
config.example.js

@@ -5,31 +5,31 @@ var config = {
     default_size: 160               // for avatars; size to be used when no size given
   },
   renders: {
-    min_scale: 1,                   // for 3D renders
-    max_scale: 10,                  // for 3D renders; too big values might lead to slow response time or DoS
-    default_scale: 6                // for 3D renders; scale to be used when no scale given
+    min_scale: 1,                   // for 3D rendered skins
+    max_scale: 10,                  // for 3D rendered skins; too big values might lead to slow response time or DoS
+    default_scale: 6                // for 3D rendered skins; scale to be used when no scale given
   },
   cleaner: {
-    interval: 1800,                 // seconds interval: deleting images if disk size at limit
-    disk_limit: 10240,              // min allowed available KB on disk to trigger cleaning
+    interval: 1800,                 // interval seconds to check limits
+    disk_limit: 10240,              // min allowed free KB on disk to trigger image deletion
     redis_limit: 24576,             // max allowed used KB on redis to trigger redis flush
-    amount: 50000                   // amount of avatar (and their helm) files to clean
+    amount: 50000                   // amount of skins for which all iamge types are deleted
   },
   directories: {
     faces_dir: "images/faces/",     // directory where faces are kept. should have trailing "/"
     helms_dir: "images/helms/",     // directory where helms are kept. should have trailing "/"
     skins_dir: "images/skins/",     // directory where skins are kept. should have trailing "/"
-    renders_dir: "images/renders/", // Directory where rendered skins are kept. should have trailing "/"
+    renders_dir: "images/renders/", // directory where rendered skins are kept. should have trailing "/"
     capes_dir: "images/capes/"      // directory where capes are kept. should have trailing "/"
   },
   caching: {
-    local_cache_time: 1200,         // seconds until we will check if the image changed. should be > 60 to prevent mojang 429 response
+    local_cache_time: 1200,         // seconds until we will check if user's skin changed. should be > 60 to comply with Mojang's rate limit
     browser_cache_time: 3600        // seconds until browser will request image again
   },
   server: {
-    http_timeout: 1000,             // ms until connection to mojang is dropped
+    http_timeout: 1000,             // ms until connection to Mojang is dropped
     debug_enabled: false,           // enables logging.debug
-    clusters: 1,                    // We recommend not using multiple clusters YET, see issue #80
+    clusters: 1,                    // we recommend not using multiple clusters YET, see issue #80
     log_time: true                  // set to false if you use an external logger that provides timestamps
   }
 };

+ 1 - 1
package.json

@@ -21,7 +21,7 @@
     "avatar"
   ],
   "scripts": {
-    "postinstall": "cp 'lib/config.example.js' 'lib/config.js'",
+    "postinstall": "cp 'config.example.js' 'config.js'",
     "start": "forever -l logs/log.log -o logs/out.log -e logs/error.log -p ./ -a --minUptime 8000 --spinSleepTime 1500 www.js",
     "test": "mocha",
     "test-travis": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"