"Fossies" - the Fresh Open Source Software Archive

Member "etherpad-lite-1.7.5/settings.json.template" (25 Jan 2019, 11689 Bytes) of package /linux/misc/etherpad-lite-1.7.5.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "settings.json.template": 1.7.0_vs_1.7.5.

    1 /*
    2  * This file must be valid JSON. But comments are allowed
    3  *
    4  * Please edit settings.json, not settings.json.template
    5  *
    6  * Please note that since Etherpad 1.6.0 you can store DB credentials in a
    7  * separate file (credentials.json).
    8  */
    9 {
   10   /*
   11    * Name your instance!
   12    */
   13   "title": "Etherpad",
   14 
   15   /*
   16    * favicon default name
   17    * alternatively, set up a fully specified Url to your own favicon
   18    */
   19   "favicon": "favicon.ico",
   20 
   21   /*
   22    * Skin name.
   23    *
   24    * Its value has to be an existing directory under src/static/skins.
   25    * You can write your own, or use one of the included ones:
   26    *
   27    * - "no-skin":  an empty skin (default). This yields the unmodified,
   28    *               traditional Etherpad theme.
   29    * - "colibris": the new experimental skin (since Etherpad 1.8), candidate to
   30    *               become the default in Etherpad 2.0
   31    */
   32   "skinName": "no-skin",
   33 
   34   /*
   35    * IP and port which etherpad should bind at
   36    */
   37   "ip": "0.0.0.0",
   38   "port" : 9001,
   39 
   40   /*
   41    * Option to hide/show the settings.json in admin page.
   42    *
   43    * Default option is set to true
   44    */
   45   "showSettingsInAdminPage" : true,
   46 
   47   /*
   48    * Node native SSL support
   49    *
   50    * This is disabled by default.
   51    * Make sure to have the minimum and correct file access permissions set so
   52    * that the Etherpad server can access them
   53    */
   54 
   55   /*
   56   "ssl" : {
   57             "key"  : "/path-to-your/epl-server.key",
   58             "cert" : "/path-to-your/epl-server.crt",
   59             "ca": ["/path-to-your/epl-intermediate-cert1.crt", "/path-to-your/epl-intermediate-cert2.crt"]
   60           },
   61   */
   62 
   63   /*
   64    * The type of the database.
   65    *
   66    * You can choose between many DB drivers, for example: dirty, postgres,
   67    * sqlite, mysql.
   68    *
   69    * You shouldn't use "dirty" for for anything else than testing or
   70    * development.
   71    *
   72    *
   73    * Database specific settings are dependent on dbType, and go in dbSettings.
   74    * Remember that since Etherpad 1.6.0 you can also store these informations in
   75    * credentials.json.
   76    *
   77    * For a complete list of the supported drivers, please refer to:
   78    * https://www.npmjs.com/package/ueberdb2
   79    */
   80 
   81   "dbType" : "dirty",
   82   "dbSettings" : {
   83                    "filename" : "var/dirty.db"
   84                  },
   85 
   86   /*
   87    * An Example of MySQL Configuration (commented out).
   88    *
   89    * See: https://github.com/ether/etherpad-lite/wiki/How-to-use-Etherpad-Lite-with-MySQL
   90    */
   91 
   92   /*
   93   "dbType" : "mysql",
   94   "dbSettings" : {
   95                    "user"    : "etherpaduser",
   96                    "host"    : "localhost",
   97                    "port"    : 3306,
   98                    "password": "PASSWORD",
   99                    "database": "etherpad_lite_db",
  100                    "charset" : "utf8mb4"
  101                  },
  102   */
  103 
  104   /*
  105    * The default text of a pad
  106    */
  107   "defaultPadText" : "Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at http:\/\/etherpad.org\n",
  108 
  109   /*
  110    * Default Pad behavior.
  111    *
  112    * Change them if you want to override.
  113    */
  114   "padOptions": {
  115     "noColors": false,
  116     "showControls": true,
  117     "showChat": true,
  118     "showLineNumbers": true,
  119     "useMonospaceFont": false,
  120     "userName": false,
  121     "userColor": false,
  122     "rtl": false,
  123     "alwaysShowChat": false,
  124     "chatAndUsers": false,
  125     "lang": "en-gb"
  126   },
  127 
  128   /*
  129    * Pad Shortcut Keys
  130    */
  131   "padShortcutEnabled" : {
  132     "altF9"     : true, /* focus on the File Menu and/or editbar */
  133     "altC"      : true, /* focus on the Chat window */
  134     "cmdShift2" : true, /* shows a gritter popup showing a line author */
  135     "delete"    : true,
  136     "return"    : true,
  137     "esc"       : true, /* in mozilla versions 14-19 avoid reconnecting pad */
  138     "cmdS"      : true, /* save a revision */
  139     "tab"       : true, /* indent */
  140     "cmdZ"      : true, /* undo/redo */
  141     "cmdY"      : true, /* redo */
  142     "cmdI"      : true, /* italic */
  143     "cmdB"      : true, /* bold */
  144     "cmdU"      : true, /* underline */
  145     "cmd5"      : true, /* strike through */
  146     "cmdShiftL" : true, /* unordered list */
  147     "cmdShiftN" : true, /* ordered list */
  148     "cmdShift1" : true, /* ordered list */
  149     "cmdShiftC" : true, /* clear authorship */
  150     "cmdH"      : true, /* backspace */
  151     "ctrlHome"  : true, /* scroll to top of pad */
  152     "pageUp"    : true,
  153     "pageDown"  : true
  154   },
  155 
  156   /*
  157    * Should we suppress errors from being visible in the default Pad Text?
  158    */
  159   "suppressErrorsInPadText" : false,
  160 
  161   /*
  162    * If this option is enabled, a user must have a session to access pads.
  163    * This effectively allows only group pads to be accessed.
  164    */
  165   "requireSession" : false,
  166 
  167   /*
  168    * Users may edit pads but not create new ones.
  169    *
  170    * Pad creation is only via the API.
  171    * This applies both to group pads and regular pads.
  172    */
  173   "editOnly" : false,
  174 
  175   /*
  176    * If set to true, those users who have a valid session will automatically be
  177    * granted access to password protected pads.
  178    */
  179   "sessionNoPassword" : false,
  180 
  181   /*
  182    * If true, all css & js will be minified before sending to the client.
  183    *
  184    * This will improve the loading performance massively, but makes it difficult
  185    * to debug the javascript/css
  186    */
  187   "minify" : true,
  188 
  189   /*
  190    * How long may clients use served javascript code (in seconds)?
  191    *
  192    * Not setting this may cause problems during deployment.
  193    * Set to 0 to disable caching.
  194    */
  195   "maxAge" : 21600, // 60 * 60 * 6 = 6 hours
  196 
  197   /*
  198    * Absolute path to the Abiword executable.
  199    *
  200    * Abiword is needed to get advanced import/export features of pads. Setting
  201    * it to null disables Abiword and will only allow plain text and HTML
  202    * import/exports.
  203    */
  204   "abiword" : null,
  205 
  206   /*
  207    * This is the absolute path to the soffice executable.
  208    *
  209    * LibreOffice can be used in lieu of Abiword to export pads.
  210    * Setting it to null disables LibreOffice exporting.
  211    */
  212   "soffice" : null,
  213 
  214   /*
  215    * Path to the Tidy executable.
  216    *
  217    * Tidy is used to improve the quality of exported pads.
  218    * Setting it to null disables Tidy.
  219    */
  220   "tidyHtml" : null,
  221 
  222   /*
  223    * Allow import of file types other than the supported ones:
  224    * txt, doc, docx, rtf, odt, html & htm
  225    */
  226   "allowUnknownFileEnds" : true,
  227 
  228   /*
  229    * This setting is used if you require authentication of all users.
  230    *
  231    * Note: "/admin" always requires authentication.
  232    */
  233   "requireAuthentication" : false,
  234 
  235   /*
  236    * Require authorization by a module, or a user with is_admin set, see below.
  237    */
  238   "requireAuthorization" : false,
  239 
  240   /*
  241    * When you use NGINX or another proxy/load-balancer set this to true.
  242    */
  243   "trustProxy" : false,
  244 
  245   /*
  246    * Privacy: disable IP logging
  247    */
  248   "disableIPlogging" : false,
  249 
  250   /*
  251    * Time (in seconds) to automatically reconnect pad when a "Force reconnect"
  252    * message is shown to user.
  253    *
  254    * Set to 0 to disable automatic reconnection.
  255    */
  256   "automaticReconnectionTimeout" : 0,
  257 
  258   /*
  259    * By default, when caret is moved out of viewport, it scrolls the minimum
  260    * height needed to make this line visible.
  261    */
  262   "scrollWhenFocusLineIsOutOfViewport": {
  263 
  264     /*
  265      * Percentage of viewport height to be additionally scrolled.
  266      *
  267      * E.g.: use "percentage.editionAboveViewport": 0.5, to place caret line in
  268      *       the middle of viewport, when user edits a line above of the
  269      *       viewport
  270      *
  271      * Set to 0 to disable extra scrolling
  272      */
  273     "percentage": {
  274       "editionAboveViewport": 0,
  275       "editionBelowViewport": 0
  276     },
  277 
  278     /*
  279      * Time (in milliseconds) used to animate the scroll transition.
  280      * Set to 0 to disable animation
  281      */
  282     "duration": 0,
  283 
  284     /*
  285      * Flag to control if it should scroll when user places the caret in the
  286      * last line of the viewport
  287      */
  288     "scrollWhenCaretIsInTheLastLineOfViewport": false,
  289 
  290     /*
  291      * Percentage of viewport height to be additionally scrolled when user
  292      * presses arrow up in the line of the top of the viewport.
  293      *
  294      * Set to 0 to let the scroll to be handled as default by Etherpad
  295      */
  296     "percentageToScrollWhenUserPressesArrowUp": 0
  297   },
  298 
  299   /*
  300    * Users for basic authentication.
  301    *
  302    * is_admin = true gives access to /admin.
  303    * If you do not uncomment this, /admin will not be available!
  304    *
  305    * WARNING: passwords should not be stored in plaintext in this file.
  306    *          If you want to mitigate this, please install ep_hash_auth and
  307    *          follow the section "secure your installation" in README.md
  308    */
  309 
  310   /*
  311   "users": {
  312     "admin": {
  313       // "password" can be replaced with "hash" if you install ep_hash_auth
  314       "password": "changeme1",
  315       "is_admin": true
  316     },
  317     "user": {
  318       // "password" can be replaced with "hash" if you install ep_hash_auth
  319       "password": "changeme1",
  320       "is_admin": false
  321     }
  322   },
  323   */
  324 
  325   /*
  326    * Restrict socket.io transport methods
  327    */
  328   "socketTransportProtocols" : ["xhr-polling", "jsonp-polling", "htmlfile"],
  329 
  330   /*
  331    * Allow Load Testing tools to hit the Etherpad Instance.
  332    *
  333    * WARNING: this will disable security on the instance.
  334    */
  335   "loadTest": false,
  336 
  337   /*
  338    * Disable indentation on new line when previous line ends with some special
  339    * chars (':', '[', '(', '{')
  340    */
  341 
  342   /*
  343   "indentationOnNewLine": false,
  344   */
  345 
  346   /*
  347    * Toolbar buttons configuration.
  348    *
  349    * Uncomment to customize.
  350    */
  351 
  352   /*
  353   "toolbar": {
  354     "left": [
  355       ["bold", "italic", "underline", "strikethrough"],
  356       ["orderedlist", "unorderedlist", "indent", "outdent"],
  357       ["undo", "redo"],
  358       ["clearauthorship"]
  359     ],
  360     "right": [
  361       ["importexport", "timeslider", "savedrevision"],
  362       ["settings", "embed"],
  363       ["showusers"]
  364     ],
  365     "timeslider": [
  366       ["timeslider_export", "timeslider_returnToPad"]
  367     ]
  368   },
  369   */
  370 
  371   /*
  372    * The log level we are using.
  373    *
  374    * Valid values: DEBUG, INFO, WARN, ERROR
  375    */
  376   "loglevel": "INFO",
  377 
  378   /*
  379    * Logging configuration. See log4js documentation for further information:
  380    * https://github.com/nomiddlename/log4js-node
  381    *
  382    * You can add as many appenders as you want here.
  383    */
  384   "logconfig" :
  385     { "appenders": [
  386         { "type": "console"
  387         //, "category": "access"// only logs pad access
  388         }
  389 
  390       /*
  391       , { "type": "file"
  392       , "filename": "your-log-file-here.log"
  393       , "maxLogSize": 1024
  394       , "backups": 3 // how many log files there're gonna be at max
  395       //, "category": "test" // only log a specific category
  396         }
  397       */
  398 
  399       /*
  400       , { "type": "logLevelFilter"
  401         , "level": "warn" // filters out all log messages that have a lower level than "error"
  402         , "appender":
  403           {  Use whatever appender you want here  }
  404         }
  405       */
  406 
  407       /*
  408       , { "type": "logLevelFilter"
  409         , "level": "error" // filters out all log messages that have a lower level than "error"
  410         , "appender":
  411           { "type": "smtp"
  412           , "subject": "An error occurred in your EPL instance!"
  413           , "recipients": "bar@blurdybloop.com, baz@blurdybloop.com"
  414           , "sendInterval": 300 // 60 * 5 = 5 minutes -- will buffer log messages; set to 0 to send a mail for every message
  415           , "transport": "SMTP", "SMTP": { // see https://github.com/andris9/Nodemailer#possible-transport-methods
  416               "host": "smtp.example.com", "port": 465,
  417               "secureConnection": true,
  418               "auth": {
  419                   "user": "foo@example.com",
  420                   "pass": "bar_foo"
  421               }
  422             }
  423           }
  424         }
  425       */
  426 
  427       ]
  428     } // logconfig
  429 }