diff options
Diffstat (limited to 'assets/js/e22ebc36.bdafc6f8.js')
| -rw-r--r-- | assets/js/e22ebc36.bdafc6f8.js | 1 |
1 files changed, 0 insertions, 1 deletions
diff --git a/assets/js/e22ebc36.bdafc6f8.js b/assets/js/e22ebc36.bdafc6f8.js deleted file mode 100644 index 5a44410..0000000 --- a/assets/js/e22ebc36.bdafc6f8.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunksite=self.webpackChunksite||[]).push([[132],{4137:function(e,t,r){"use strict";r.d(t,{Zo:function(){return c},kt:function(){return p}});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){i(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function a(e,t){if(null==e)return{};var r,n,i=function(e,t){if(null==e)return{};var r,n,i={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var s=n.createContext({}),u=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=u(e.components);return n.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,c=a(e,["components","mdxType","originalType","parentName"]),h=u(r),p=i,g=h["".concat(s,".").concat(p)]||h[p]||d[p]||o;return r?n.createElement(g,l(l({ref:t},c),{},{components:r})):n.createElement(g,l({ref:t},c))}));function p(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=r.length,l=new Array(o);l[0]=h;var a={};for(var s in t)hasOwnProperty.call(t,s)&&(a[s]=t[s]);a.originalType=e,a.mdxType="string"==typeof e?e:i,l[1]=a;for(var u=2;u<o;u++)l[u]=r[u];return n.createElement.apply(null,l)}return n.createElement.apply(null,r)}h.displayName="MDXCreateElement"},9998:function(e,t,r){"use strict";r.r(t),r.d(t,{frontMatter:function(){return a},contentTitle:function(){return s},metadata:function(){return u},toc:function(){return c},default:function(){return h}});var n=r(2122),i=r(9756),o=(r(7294),r(4137)),l=["components"],a={title:"Configuration"},s=void 0,u={unversionedId:"whirl/configuration",id:"whirl/configuration",isDocsHomePage:!1,title:"Configuration",description:"Whirlsplash",source:"@site/docs/whirl/configuration.md",sourceDirName:"whirl",slug:"/whirl/configuration",permalink:"/docs/whirl/configuration",editUrl:"https://github.com/whirlsplash/site/edit/master/website/docs/whirl/configuration.md",version:"current",frontMatter:{title:"Configuration"},sidebar:"docs",previous:{title:"Deploying (Setup)",permalink:"/docs/whirl/deploying_setup"},next:{title:"UserServer Configuration Options",permalink:"/docs/gammadocs/roomserver/userserver-configuration-options"}},c=[{value:"Whirlsplash",id:"whirlsplash",children:[{value:"WorldsMaster Username",id:"worldsmaster-username",children:[]},{value:"IP",id:"ip",children:[]},{value:"API",id:"api",children:[]},{value:"Prompt",id:"prompt",children:[]},{value:"Log",id:"log",children:[]}]},{value:"Distributor",id:"distributor",children:[{value:"WorldsMaster Greeting",id:"worldsmaster-greeting",children:[]},{value:"Port",id:"port-1",children:[]}]},{value:"Hub",id:"hub",children:[{value:"Port",id:"port-2",children:[]}]}],d={toc:c};function h(e){var t=e.components,r=(0,i.Z)(e,l);return(0,o.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"whirlsplash"},"Whirlsplash"),(0,o.kt)("h3",{id:"worldsmaster-username"},"WorldsMaster Username"),(0,o.kt)("p",null,"The server operator's username."),(0,o.kt)("p",null,"This should NOT be changed under normal circumstances."),(0,o.kt)("h3",{id:"ip"},"IP"),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"This configuration option may become deprecated in the near:\n",(0,o.kt)("a",{parentName:"strong",href:"https://github.com/Whirlsplash/whirl/issues/18"},"issue"),".")),(0,o.kt)("p",null,"The Internet Protocol address of the host's machine."),(0,o.kt)("p",null,"When connecting to a local server (client and host both originate from the same machine), a value of\n",(0,o.kt)("inlineCode",{parentName:"p"},"0.0.0.0")," or ",(0,o.kt)("inlineCode",{parentName:"p"},"127.0.0.1")," is fine, however, if you are hosting a server publicly as service, this\nshould be changed to the host's IP address."),(0,o.kt)("h3",{id:"api"},"API"),(0,o.kt)("h4",{id:"port"},"Port"),(0,o.kt)("p",null,"The port on which Whirl's administration and statistics server is listening."),(0,o.kt)("h3",{id:"prompt"},"Prompt"),(0,o.kt)("h4",{id:"enable"},"Enable"),(0,o.kt)("p",null,"Manually enable the Whirl Shell."),(0,o.kt)("h4",{id:"ps1"},"PS1"),(0,o.kt)("p",null,"Similar to a PS1 as seen in *nix-based operating systems, the Prompt String/ Statement One is the\nprompt string which will appear if you have the Whirl Shell enabled."),(0,o.kt)("h3",{id:"log"},"Log"),(0,o.kt)("h4",{id:"enable-1"},"Enable"),(0,o.kt)("p",null,"Toggle the logging functionality of Whirl."),(0,o.kt)("h4",{id:"level"},"Level"),(0,o.kt)("p",null,"The level of logging which the serve should emit."),(0,o.kt)("p",null,"By default, ",(0,o.kt)("strong",{parentName:"p"},"errors"),", ",(0,o.kt)("strong",{parentName:"p"},"warnings"),", and ",(0,o.kt)("strong",{parentName:"p"},"info")," (1) logs are emitted, however, you can change\nthis value to enable ",(0,o.kt)("strong",{parentName:"p"},"debug")," (2) and ",(0,o.kt)("strong",{parentName:"p"},"trace")," (3) logs."),(0,o.kt)("p",null,"Under normal circumstances, this value should only be changed when instructed to or if you are\nexperiencing any undefined/ unexpected behaviours and you would like to try self-debugging."),(0,o.kt)("h4",{id:"everything"},"Everything"),(0,o.kt)("p",null,"Enables logging from ",(0,o.kt)("strong",{parentName:"p"},"ALL")," of Whirl and it's dependencies."),(0,o.kt)("p",null,"It it's default state, false, only Whirl's core crates emit logging information, with this\nconfiguration key enabled, ",(0,o.kt)("strong",{parentName:"p"},"ALL")," of Whirl's external dependencies will emit logging information."),(0,o.kt)("p",null,"This configuration key is best left disabled."),(0,o.kt)("h4",{id:"test"},"Test"),(0,o.kt)("p",null,"Emits a single log for each log level, useful for debugging."),(0,o.kt)("h4",{id:"file"},"File"),(0,o.kt)("p",null,"If enabled, logs will be emitted to a file within a directory relative to the Whirl binary in a\ndirectory named ",(0,o.kt)("inlineCode",{parentName:"p"},"log"),". If disabled, logs will be emitted to standard out."),(0,o.kt)("h2",{id:"distributor"},"Distributor"),(0,o.kt)("h3",{id:"worldsmaster-greeting"},"WorldsMaster Greeting"),(0,o.kt)("p",null,'The first message or "greeting" which is sent to a user once connected to a WorldServer.'),(0,o.kt)("h3",{id:"port-1"},"Port"),(0,o.kt)("p",null,"The port which the Distributor may be accessed from."),(0,o.kt)("p",null,"This should NOT be changed under any\ncircumstances."),(0,o.kt)("h2",{id:"hub"},"Hub"),(0,o.kt)("h3",{id:"port-2"},"Port"),(0,o.kt)("p",null,"The port which the Hub may be accessed from."),(0,o.kt)("p",null,"This should NOT be changed under any\ncircumstances."))}h.isMDXComponent=!0}}]);
\ No newline at end of file |