Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
config:webv4 [2021/01/27 13:13] – webv4 configuration ecbbsconfig:webv4 [2022/03/14 20:05] (current) – [See Also] tags Andre
Line 1: Line 1:
 ====== webv4 Configuration ====== ====== webv4 Configuration ======
  
-The optional webv4 user interface is located in the ''webv4/'' directory and is available from the [[dev:git]] repository.+The optional echicken webv4 user interface for Synchronet (a.k.a. ecweb v4, or ecwebv4) is located in the ''webv4/'' directory and is available from the [[dev:git]] repository. 
 + 
 +===== Enable =====
  
 To enable webv4, edit [[config:sbbs.ini]] so that the ''RootDirectory'' key under the ''[Web]'' section points to ''../webv4/root''. You'll also want to ensure that ''index.xjs'' is included in your list of IndexFileNames: To enable webv4, edit [[config:sbbs.ini]] so that the ''RootDirectory'' key under the ''[Web]'' section points to ''../webv4/root''. You'll also want to ensure that ''index.xjs'' is included in your list of IndexFileNames:
Line 20: Line 22:
 </code> </code>
  
-webv4's settings are contained in the ''[web]'' section of ''[[dir:ctrl]]/modopts.ini''. If your copy of ''[[dir:ctrl]]/modopts.ini'' does not have this section, or is missing one of the settings, then the default value (shown below) will be used.+To disable webv4 (or switch back to the old web UI), edit [[config:sbbs.ini]] and set the value of ''RootDirectory'' back to what it was before (eg. ''../web''). 
 + 
 +===== Configure ===== 
 + 
 +webv4's settings are contained in the ''[web]'' section of ''[[dir:ctrl]]/modopts.ini''. 
 + 
 +Shown below are the default values. If your ''[[dir:ctrl]]/modopts.ini'' file does not have a ''[web]'' section, or is missing one of these values, the default will be used.
  
 ''[[dir:ctrl]]/modopts.ini'' ''[[dir:ctrl]]/modopts.ini''
Line 79: Line 87:
 ; Enable with caution due to security implications (eg. user-uploaded HTML files) ; Enable with caution due to security implications (eg. user-uploaded HTML files)
 files_inline = false files_inline = false
 +; Offer dark mode to users
 +darkmode_allow = true
 +; Enable dark mode by default:
 +darkmode_on = false
 </code> </code>
  
-Optional new user account settings are available. If these are absent from ''[[dir:ctrl]]/modopts.ini'', the system defaults will be applied. Only add these settings if you know that you need them.+==== New User Values ==== 
 + 
 +If you enabled ''user_registration'' above, new users can sign up via your website. If you want to apply a special security level, flags, exemptions, or restrictions to these users, you can add any or all of the following settings to the ''[web]'' section of ''[[dir:ctrl]]/modopts.ini'':
  
 ''[[dir:ctrl]]/modopts.ini'' ''[[dir:ctrl]]/modopts.ini''
Line 95: Line 109:
 newuser_restrictions = ABCDEFGHIJKLMNOPQRSTUVWXYZ newuser_restrictions = ABCDEFGHIJKLMNOPQRSTUVWXYZ
 </code> </code>
 +
 +If these settings are absent, then the system defaults (as set in scfg) will be used.
 +
 +==== Optional Settings ====
  
 Advanced settings are available but not included by default. These are: Advanced settings are available but not included by default. These are:
Line 113: Line 131:
  
 * Tweaking the `max_messages` setting may help if you get _out of memory_ errors or find your site being hit hard by bots / search indexers. * Tweaking the `max_messages` setting may help if you get _out of memory_ errors or find your site being hit hard by bots / search indexers.
 +
 +===== fTelnet =====
 +
 +[[https://www.ftelnet.ca/|fTelnet]] is a web-based telnet/rlogin client written by [[https://www.rickparrish.ca/|Rick Parrish]]. It's the telnet client that you see on the Home and Games pages of a typical webv4 site.
 +
 +fTelnet **does not** connect directly to your telnet server. fTelnet connects to a ''WebSocket proxy server'', which mediates between fTelnet and the telnet server. The ''WebSocket proxy server'' runs on your server, and must be running and reachable by external clients in order for this to work.
 +
 +To enable the WebSocket service, ensure that you have the following section in ''[[dir:ctrl]]/services.ini'':
 +
 +<code ini>
 +[WS]
 +Port=1123
 +Options=NO_HOST_LOOKUP
 +Command=websocketservice.js
 +</code>
 +
 +If you server your website via ''HTTPS'', you should also include a ''[WSS]'' (WebSocket Secure) service definition:
 +
 +<code ini>
 +[WSS]
 +Port=11235
 +Options=NO_HOST_LOOKUP|TLS
 +Command=websocketservice.js
 +</code>
 +
 +You must also ensure that the above ports are open in your firewall, and forwarded to your BBS if necessary.
 +
 +**Before you request support for fTelnet, please double-check that the above sections exist in ''[[dir:ctrl]]/services.ini'', and that the relevant ports are open in your firewall and forwarded in your BBS. Now go and check again. This is the problem 99.5% of the time.**
  
 ===== See Also ===== ===== See Also =====
   * [[:config:|config index]]   * [[:config:|config index]]
  
-{{tag>}}+{{tag>configuration web_server}}
  

Trace: