diff options
Diffstat (limited to 'docs/gammadocs/roomserver/userserver-configuration-options/index.html')
| -rw-r--r-- | docs/gammadocs/roomserver/userserver-configuration-options/index.html | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/gammadocs/roomserver/userserver-configuration-options/index.html b/docs/gammadocs/roomserver/userserver-configuration-options/index.html new file mode 100644 index 0000000..4311d61 --- /dev/null +++ b/docs/gammadocs/roomserver/userserver-configuration-options/index.html @@ -0,0 +1,47 @@ +<!doctype html> +<html lang="en" dir="ltr"> +<head> +<meta charset="UTF-8"> +<meta name="viewport" content="width=device-width,initial-scale=1"> +<meta name="generator" content="Docusaurus v2.0.0-alpha.72"> +<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Whirlsplash Blog RSS Feed"> +<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Whirlsplash Blog Atom Feed"><title data-react-helmet="true">UserServer Configuration Options | Whirlsplash</title><meta data-react-helmet="true" property="og:url" content="https://whirlsplash.org/docs/gammadocs/roomserver/userserver-configuration-options"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="UserServer Configuration Options | Whirlsplash"><meta data-react-helmet="true" name="description" content="Logging"><meta data-react-helmet="true" property="og:description" content="Logging"><link data-react-helmet="true" rel="shortcut icon" href="/img/Whirl.png"><link data-react-helmet="true" rel="canonical" href="https://whirlsplash.org/docs/gammadocs/roomserver/userserver-configuration-options"><link data-react-helmet="true" rel="alternate" href="https://whirlsplash.org/docs/gammadocs/roomserver/userserver-configuration-options" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://whirlsplash.org/docs/gammadocs/roomserver/userserver-configuration-options" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.e6859df5.css"> +<link rel="preload" href="/assets/js/styles.46ced95d.js" as="script"> +<link rel="preload" href="/assets/js/runtime~main.fdd555b2.js" as="script"> +<link rel="preload" href="/assets/js/main.969a5efd.js" as="script"> +<link rel="preload" href="/assets/js/1.30a4998b.js" as="script"> +<link rel="preload" href="/assets/js/2.6197f8d3.js" as="script"> +<link rel="preload" href="/assets/js/3.32caa768.js" as="script"> +<link rel="preload" href="/assets/js/1be78505.6334c1c2.js" as="script"> +<link rel="preload" href="/assets/js/41.8b6e6f9b.js" as="script"> +<link rel="preload" href="/assets/js/935f2afb.2320539b.js" as="script"> +<link rel="preload" href="/assets/js/17896441.98b94edc.js" as="script"> +<link rel="preload" href="/assets/js/4837446e.dc774aae.js" as="script"> +</head> +<body> +<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?e("light"):e("dark")}()</script><div id="__docusaurus"> +<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle" type="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/Whirl.png" alt="Whirlsplash logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/Whirl.png" alt="Whirlsplash logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><strong class="navbar__title">Whirlsplash</strong></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/">Docs</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/whirlsplash/site" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--checked react-toggle--disabled displayOnlyInLargeViewport_GrZ2"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_71bT">๐</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">๐</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" checked="" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/Whirl.png" alt="Whirlsplash logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/Whirl.png" alt="Whirlsplash logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><strong class="navbar__title">Whirlsplash</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs/">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a href="https://github.com/whirlsplash/site" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper main-docs-wrapper"><div class="docPage_31aa"><div class="docSidebarContainer_3Kbt" role="complementary"><div class="sidebar_15mo"><div class="menu menu--responsive thin-scrollbar menu_Bmed"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_fgN0" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Introduction</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/">Basis</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/introduction/resources">Resources</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/introduction/workflow">Workflow</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/introduction/contributing">Contributing</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">GammaDocs</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/gammadocs/roomserver/userserver-configuration-options">UserServer Configuration Options</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">WorldServer Protocol</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worldserver-protocol/packet-information">Packet Information</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worldserver-protocol/network-constants">Network Constants</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worldserver-protocol/roomserver">RoomServer</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worldserver-protocol/userserver">UserServer</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">worlds.jar</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">NET.worlds</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">network</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worlds-jar/net-worlds/network/objid">ObjId</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worlds-jar/net-worlds/network/serveroutputstream">ServerOutputStream</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worlds-jar/net-worlds/network/netconst">netConst</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/worlds-jar/net-worlds/network/netpacket">netPacket</a></li></ul></li></ul></li></ul></li></ul></div></div></div><main class="docMainContainer_3ufF"><div class="container padding-vert--lg docItemWrapper_3FMP"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><header><h1 class="docTitle_3a4h">UserServer Configuration Options</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="logging"></a>Logging<a class="hash-link" href="#logging" title="Direct link to heading">#</a></h2><p>Inclusion of this keyword enables logging of every command that passes over the network (both +input and output), as well as logging of various other information. It is primarily intended to be +used for debugging. All of this debugging information is appended to the ".out" file not the ".log" +file.</p><p>Logging can also be toggled on and off while the UserServer is running by sending the server +SIGUSR1: <code>kill -USR1 pid</code></p><p>Use logging carefully, it generates a very large amount of output to the UserServer output file. +Logging functionality and these keywords are only available in UserServers that have been compiled +for Worlds' internal use.</p><p>This feature is disabled by default.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="internalhttpserver"></a>InternalHttpServer<a class="hash-link" href="#internalhttpserver" title="Direct link to heading">#</a></h3><p>This is the base URL of the machine to use for handling HTTP requests for the internal version of +Gamma. For example: <a href="http://dev.worlds.net" target="_blank" rel="noopener noreferrer">http://dev.worlds.net</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="externalhttpserver"></a>ExternalHttpServer<a class="hash-link" href="#externalhttpserver" title="Direct link to heading">#</a></h3><p>This is the base URL of the machine to use for handling static HTTP requests for the release (i.e. +external) version of Gamma. For example: <a href="http://www-static.us.worlds.net" target="_blank" rel="noopener noreferrer">http://www-static.us.worlds.net</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="scriptserver"></a>ScriptServer<a class="hash-link" href="#scriptserver" title="Direct link to heading">#</a></h3><p>Similar to ExternalHttpServer, this is the URL of the directory where server scripts should be +executed. This is for things like the registration script and various other maintenance scripts. +Example: <a href="http://www-dynamic.us.worlds.net/cgi-bin" target="_blank" rel="noopener noreferrer">http://www-dynamic.us.worlds.net/cgi-bin</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="bindaddr-userserver-only"></a>BindAddr (UserServer only)<a class="hash-link" href="#bindaddr-userserver-only" title="Direct link to heading">#</a></h3><p>Used when you wish to run two UserServers on a single multi-homed machine. This is really only +useful for redirecting traffic on one of the UserServers to a set of remote RoomServers.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="smtpserver"></a>SmtpServer<a class="hash-link" href="#smtpserver" title="Direct link to heading">#</a></h3><p>The SMTP server to used to connect to for sending WorldsMail.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="maildomain"></a>MailDomain<a class="hash-link" href="#maildomain" title="Direct link to heading">#</a></h3><p>The DNS domain to use in the "from" address when sending WorldsMail.</p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/whirlsplash/site/edit/master/website/docs/gammadocs/roomserver/userserver-configuration-options.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-label="Edit page"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/introduction/contributing"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">ยซ Contributing</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/worldserver-protocol/packet-information"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Packet Information ยป</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#logging" class="table-of-contents__link">Logging</a><ul><li><a href="#internalhttpserver" class="table-of-contents__link">InternalHttpServer</a></li><li><a href="#externalhttpserver" class="table-of-contents__link">ExternalHttpServer</a></li><li><a href="#scriptserver" class="table-of-contents__link">ScriptServer</a></li><li><a href="#bindaddr-userserver-only" class="table-of-contents__link">BindAddr (UserServer only)</a></li><li><a href="#smtpserver" class="table-of-contents__link">SmtpServer</a></li><li><a href="#maildomain" class="table-of-contents__link">MailDomain</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/">Getting Started</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://discord.com/invite/8hn6padWF6" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://github.com/whirlsplash" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://github.com/Whirlsplash/site/blob/main/LICENSE" target="_blank" rel="noopener noreferrer" class="footer__link-item">License</a></li></ul></div></div><div class="footer__bottom text--center"></div></div></footer></div> +<script src="/assets/js/styles.46ced95d.js"></script> +<script src="/assets/js/runtime~main.fdd555b2.js"></script> +<script src="/assets/js/main.969a5efd.js"></script> +<script src="/assets/js/1.30a4998b.js"></script> +<script src="/assets/js/2.6197f8d3.js"></script> +<script src="/assets/js/3.32caa768.js"></script> +<script src="/assets/js/1be78505.6334c1c2.js"></script> +<script src="/assets/js/41.8b6e6f9b.js"></script> +<script src="/assets/js/935f2afb.2320539b.js"></script> +<script src="/assets/js/17896441.98b94edc.js"></script> +<script src="/assets/js/4837446e.dc774aae.js"></script> +</body> +</html>
\ No newline at end of file |