2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-06-15 21:52:33 +02:00
< head >
< meta charset = "utf-8" / >
2020-10-15 01:31:30 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2020-06-15 21:52:33 +02:00
< title > HAProxy Config (Optional) — Evennia 1.0-dev documentation< / title >
2020-07-14 00:21:00 +02:00
< link rel = "stylesheet" href = "../_static/nature.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/language_data.js" > < / script >
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2020-06-15 21:52:33 +02:00
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
accesskey="I">index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / a > |< / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > HAProxy Config (Optional)< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2020-11-14 11:55:52 +01:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2020-06-13 00:36:45 +02:00
< div class = "section" id = "haproxy-config-optional" >
< h1 > HAProxy Config (Optional)< a class = "headerlink" href = "#haproxy-config-optional" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "evennia-https-and-secure-websockets-can-play-nicely-together-quickly" >
< h2 > Evennia, HTTPS and Secure Websockets can play nicely together, quickly.< a class = "headerlink" href = "#evennia-https-and-secure-websockets-can-play-nicely-together-quickly" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-07-14 00:21:00 +02:00
< p > This sets up HAProxy 1.5+ in front of Evennia to provide security.< / p >
2020-06-13 00:36:45 +02:00
< p > Installing HAProxy is usually as simple as:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # Redhat derivatives< / span >
< span class = "n" > yum< / span > < span class = "n" > install< / span > < span class = "n" > haproxy< / span >
< span class = "c1" > # dnf instead of yum for very recent Fedora distros.< / span >
< / pre > < / div >
< / div >
< p > or< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # Debian derivatives< / span >
< span class = "n" > apt< / span > < span class = "n" > install< / span > < span class = "n" > haproxy< / span >
< / pre > < / div >
< / div >
< p > Configuration of HAProxy requires a single file given as an argument on the command line:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > haproxy< / span > < span class = "o" > -< / span > < span class = "n" > f< / span > < span class = "o" > /< / span > < span class = "n" > path< / span > < span class = "o" > /< / span > < span class = "n" > to< / span > < span class = "o" > /< / span > < span class = "n" > config< / span > < span class = "o" > .< / span > < span class = "n" > file< / span >
< / pre > < / div >
< / div >
< p > In it (example using haproxy 1.5.18 on Centos7):< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # stuff provided by the default haproxy installs< / span >
< span class = "k" > global< / span >
< span class = "n" > log< / span > < span class = "o" > /< / span > < span class = "n" > dev< / span > < span class = "o" > /< / span > < span class = "n" > log< / span > < span class = "n" > local0< / span >
< span class = "n" > chroot< / span > < span class = "o" > /< / span > < span class = "n" > var< / span > < span class = "o" > /< / span > < span class = "n" > lib< / span > < span class = "o" > /< / span > < span class = "n" > haproxy< / span >
< span class = "n" > maxconn< / span > < span class = "mi" > 4000< / span >
< span class = "n" > user< / span > < span class = "n" > haproxy< / span >
< span class = "n" > defaults< / span >
< span class = "n" > mode< / span > < span class = "n" > http< / span >
< span class = "n" > option< / span > < span class = "n" > forwardfor< / span >
< span class = "c1" > # Evennia Specifics< / span >
< span class = "n" > listen< / span > < span class = "n" > evennia< / span > < span class = "o" > -< / span > < span class = "n" > https< / span > < span class = "o" > -< / span > < span class = "n" > website< / span >
2020-06-16 22:49:43 +02:00
< span class = "n" > bind< / span > < span class = "o" > < < / span > < span class = "n" > public< / span > < span class = "o" > -< / span > < span class = "n" > ip< / span > < span class = "o" > -< / span > < span class = "n" > address< / span > < span class = "o" > > < / span > < span class = "p" > :< / span > < span class = "o" > < < / span > < span class = "n" > public< / span > < span class = "o" > -< / span > < span class = "n" > SSL< / span > < span class = "o" > -< / span > < span class = "n" > port< / span > < span class = "o" > --< / span > < span class = "n" > probably< / span > < span class = "o" > -< / span > < span class = "mi" > 443< / span > < span class = "o" > > < / span > < span class = "n" > ssl< / span > < span class = "n" > no< / span > < span class = "o" > -< / span > < span class = "n" > sslv3< / span > < span class = "n" > no< / span > < span class = "o" > -< / span > < span class = "n" > tlsv10< / span > < span class = "n" > crt< / span >
< span class = "o" > /< / span > < span class = "n" > path< / span > < span class = "o" > /< / span > < span class = "n" > to< / span > < span class = "o" > /< / span > < span class = "n" > your< / span > < span class = "o" > -< / span > < span class = "n" > cert< / span > < span class = "o" > .< / span > < span class = "n" > pem< / span >
2020-06-13 00:36:45 +02:00
< span class = "n" > server< / span > < span class = "n" > localhost< / span > < span class = "mf" > 127.0< / span > < span class = "o" > .< / span > < span class = "mf" > 0.1< / span > < span class = "p" > :< / span > < span class = "o" > < < / span > < span class = "n" > evennia< / span > < span class = "o" > -< / span > < span class = "n" > web< / span > < span class = "o" > -< / span > < span class = "n" > port< / span > < span class = "o" > -< / span > < span class = "n" > probably< / span > < span class = "o" > -< / span > < span class = "mi" > 4001< / span > < span class = "o" > > < / span >
< span class = "n" > listen< / span > < span class = "n" > evennia< / span > < span class = "o" > -< / span > < span class = "n" > secure< / span > < span class = "o" > -< / span > < span class = "n" > websocket< / span >
2020-06-16 22:49:43 +02:00
< span class = "n" > bind< / span > < span class = "o" > < < / span > < span class = "n" > public< / span > < span class = "o" > -< / span > < span class = "n" > ip< / span > < span class = "o" > -< / span > < span class = "n" > address< / span > < span class = "o" > > < / span > < span class = "p" > :< / span > < span class = "o" > < < / span > < span class = "n" > WEBSOCKET_CLIENT_URL< / span > < span class = "mi" > 4002< / span > < span class = "o" > > < / span > < span class = "n" > ssl< / span > < span class = "n" > no< / span > < span class = "o" > -< / span > < span class = "n" > sslv3< / span > < span class = "n" > no< / span > < span class = "o" > -< / span > < span class = "n" > tlsv10< / span > < span class = "n" > crt< / span > < span class = "o" > /< / span > < span class = "n" > path< / span > < span class = "o" > /< / span > < span class = "n" > to< / span > < span class = "o" > /< / span > < span class = "n" > your< / span > < span class = "o" > -< / span >
< span class = "n" > cert< / span > < span class = "o" > .< / span > < span class = "n" > pem< / span >
2020-06-13 00:36:45 +02:00
< span class = "n" > server< / span > < span class = "n" > localhost< / span > < span class = "mf" > 127.0< / span > < span class = "o" > .< / span > < span class = "mf" > 0.1< / span > < span class = "p" > :< / span > < span class = "o" > < < / span > < span class = "n" > WEBSOCKET_CLIENT_URL< / span > < span class = "mi" > 4002< / span > < span class = "o" > > < / span >
< span class = "n" > timeout< / span > < span class = "n" > client< / span > < span class = "mi" > 10< / span > < span class = "n" > m< / span >
< span class = "n" > timeout< / span > < span class = "n" > server< / span > < span class = "mi" > 10< / span > < span class = "n" > m< / span >
< / pre > < / div >
< / div >
< p > Then edit mygame/server/conf/settings.py and add:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > WEBSERVER_INTERFACES< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' 127.0.0.1' < / span > < span class = "p" > ]< / span >
< span class = "n" > WEBSOCKET_CLIENT_INTERFACE< / span > < span class = "o" > =< / span > < span class = "s1" > ' 127.0.0.1' < / span >
< / pre > < / div >
< / div >
< p > or< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > LOCKDOWN_MODE< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
< / pre > < / div >
< / div >
< p > and< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > WEBSOCKET_CLIENT_URL< / span > < span class = "o" > =< / span > < span class = "s2" > " wss://yourhost.com:4002/" < / span >
< / pre > < / div >
< / div >
< / div >
< / div >
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-06-13 00:36:45 +02:00
< / div >
< / div >
< / div >
2020-06-15 21:52:33 +02:00
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
2020-07-14 00:21:00 +02:00
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
2020-06-15 21:52:33 +02:00
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
2020-07-14 00:21:00 +02:00
< form class = "search" action = "../search.html" method = "get" >
2020-06-15 21:52:33 +02:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
2020-07-14 00:21:00 +02:00
< p > < h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
2020-06-15 21:52:33 +02:00
< ul >
< li > < a class = "reference internal" href = "#" > HAProxy Config (Optional)< / a > < ul >
< li > < a class = "reference internal" href = "#evennia-https-and-secure-websockets-can-play-nicely-together-quickly" > Evennia, HTTPS and Secure Websockets can play nicely together, quickly.< / a > < / li >
< / ul >
< / li >
< / ul >
2020-06-13 00:36:45 +02:00
2020-06-15 21:52:33 +02:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2020-07-14 00:21:00 +02:00
< li > < a href = "../_sources/Setup/HAProxy-Config.md.txt"
2020-06-15 21:52:33 +02:00
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div >
< h3 > Versions< / h3 >
< ul >
2020-07-14 00:21:00 +02:00
< li > < a href = "HAProxy-Config.html" > 1.0-dev (develop branch)< / a > < / li >
2020-10-11 22:19:29 +02:00
< li > < a href = "../../0.9.5/index.html" > 0.9.5 (master branch)< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2020-06-14 21:48:02 +02:00
2020-06-15 21:52:33 +02:00
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
>index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / a > |< / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > HAProxy Config (Optional)< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2020-11-14 11:55:52 +01:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
2020-06-15 21:52:33 +02:00
< / div >
< / body >
2020-06-13 00:36:45 +02:00
< / html >
