Skip to content
This repository has been archived by the owner on Mar 20, 2023. It is now read-only.

Commit

Permalink
Update example-settings.json
Browse files Browse the repository at this point in the history
  • Loading branch information
@Arlen22
Arlen22 committed Sep 7, 2019
1 parent 9510e51 commit 0ba8d16
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/SettingsJson.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ title: settings.json

The settings.json file is used to tell the server what settings to use. The detailed specification is in ServerConfig, but this should get you up and running.

<div style="color: rgb(0, 0, 0); font-family: Menlo, Monaco, &quot;Courier New&quot;, monospace; font-size: 12px; line-height: 18px; white-space: pre; overflow: scroll hidden;"><div>{</div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//The JSON5 parser allows comments!</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//All relative paths are relative to this file.</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//The user directory prefix ~ is allowed.</span></div><br><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"tree"</span>: <span style="color: rgb(163, 21, 21);">"../webroot"</span>, <span style="color: rgb(0, 128, 0);">//this tree is just going to mount a folder as root: ../webroot</span></div><br><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// That line could also look like this:</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// { </span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// &nbsp;//this tree is just going to mount a folder as root: ../webroot</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// &nbsp;"$element": "folder",</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// &nbsp;"path": "../webroot",</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// },</span></div><br><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"bindInfo"</span>: {</div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// V V V V Uncomment one of the following V V V V </span></div><br><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//bind to localhost only (you can specify any other ip address in this array, and it will bind to all available addresses)</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// "bindAddress": ["127.0.0.1"],</span></div><br><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//bind to 0.0.0.0</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// "bindWildcard": true</span></div><br><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//workaround for android devices (bind to all available private ip addresses on startup)</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// "bindWildcard": false, "bindAddress": ["192.168.0.0/16", "10.0.0.0/8", "172.31.0.0/16"], "filterBindAddress": true,</span></div><div>&nbsp;&nbsp;},</div><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"putsaver"</span>: {</div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//single file wikis will backup to this directory on every save</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"backupFolder"</span>: <span style="color: rgb(163, 21, 21);">"../backups"</span> <span style="color: rgb(0, 128, 0);">// comment out or set to "" to disable backups</span></div><div>&nbsp;&nbsp;},</div><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"$schema"</span>: <span style="color: rgb(163, 21, 21);">"./settings-2-1.schema.json"</span></div><div>}</div></div>
<div style="color: rgb(0, 0, 0); font-family: Menlo, Monaco, &quot;Courier New&quot;, monospace; font-size: 12px; line-height: 18px; white-space: pre; overflow: scroll hidden;"><div>{</div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//The JSON5 parser allows comments!</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//All relative paths are relative to this file.</span></div><div>&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//The user directory prefix ~ is allowed.</span></div><br><div> <span style="color: rgb(0, 128, 0);">//remove one of these</span></div><div> <span style="color: rgb(4, 81, 165);">"tree"</span>: <span style="color: rgb(163, 21, 21);">"../webroot"</span>, <span style="color: rgb(0, 128, 0);">//this tree is just going to mount a folder as root: ../webroot</span></div><div> </div><div> <span style="color: rgb(4, 81, 165);">"tree"</span>: { <span style="color: rgb(0, 128, 0);">//this tree is going to mount a group containing folders and another group</span></div><div> <span style="color: rgb(4, 81, 165);">"myfolder"</span>: <span style="color: rgb(163, 21, 21);">"../personal"</span>,</div><div> <span style="color: rgb(4, 81, 165);">"workstuff"</span>: <span style="color: rgb(163, 21, 21);">"../work"</span>,</div><div> <span style="color: rgb(4, 81, 165);">"user"</span>: <span style="color: rgb(163, 21, 21);">"~/Desktop/random"</span>,</div><div> <span style="color: rgb(4, 81, 165);">"projects_group"</span>: {</div><div> <span style="color: rgb(4, 81, 165);">"tiddlyserver"</span>: <span style="color: rgb(163, 21, 21);">"~/Desktop/Github/TiddlyServer"</span>,</div><div> <span style="color: rgb(4, 81, 165);">"material-theme"</span>: <span style="color: rgb(163, 21, 21);">"~/Dropbox/Material Theme"</span></div><div> }</div><div> },</div><br><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"bindInfo"</span>: {</div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// V V V V Uncomment one of the following V V V V </span></div><br><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//bind to localhost only (you can specify any other ip address in this array, and it will bind to all available addresses)</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// "bindAddress": ["127.0.0.1"],</span></div><br><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//bind to 0.0.0.0</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// "bindWildcard": true</span></div><br><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//workaround for android devices (bind to all available private ip addresses on startup)</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">// "bindWildcard": false, "bindAddress": ["192.168.0.0/16", "10.0.0.0/8", "172.31.0.0/16"], "filterBindAddress": true,</span></div><div>&nbsp;&nbsp;},</div><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"putsaver"</span>: {</div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(0, 128, 0);">//single file wikis will backup to this directory on every save</span></div><div>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"backupFolder"</span>: <span style="color: rgb(163, 21, 21);">"../backups"</span> <span style="color: rgb(0, 128, 0);">// comment out or set to "" to disable backups</span></div><div>&nbsp;&nbsp;},</div><div>&nbsp;&nbsp;<span style="color: rgb(4, 81, 165);">"$schema"</span>: <span style="color: rgb(163, 21, 21);">"./settings-2-1.schema.json"</span></div><div>}</div></div>
20 changes: 12 additions & 8 deletions example-settings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@
//All relative paths are relative to this file.
//The user directory prefix ~ is allowed.

"tree": "../webroot", //this tree is just going to mount a folder as root: ../webroot

// That line could also look like this:
// {
// //this tree is just going to mount a folder as root: ../webroot
// "$element": "folder",
// "path": "../webroot",
// },
//remove one of these
"tree": "../webroot", //this tree is just going to mount a folder as root: ../webroot

"tree": { //this tree is going to mount a group containing folders and another group
"myfolder": "../personal",
"workstuff": "../work",
"user": "~/Desktop/random",
"projects_group": {
"tiddlyserver": "~/Desktop/Github/TiddlyServer",
"material-theme": "~/Dropbox/Material Theme"
}
},

"bindInfo": {
// V V V V Uncomment one of the following V V V V
Expand Down

0 comments on commit 0ba8d16

Please sign in to comment.