Added multistage, configs, and shrunk size

webserver/config.py

@@ -0,0 +1,212 @@
+# Warning! Servers will not update or merge with the version controlled copy of
+# this file, so any parameters here, and code that uses them, need to come
+# without the assumption that they will be present in any given config.py on a
+# server. Furthermore, on a typical rebuild in a production server, a running
+# webtiles server *will not restart*, so you can't even assume that any config-
+# specific code that you've added will be consistently present. This
+# particularly impacts templated html files, which are loaded and called
+# dynamically, so *do* get updated immediately on a rebuild. If something like
+# client.html raises an exception, this will trigger 500 errors across the whole
+# server.
+#
+# One useful workaround for all this is to get config paramters with the builtin
+# `getattr` function: e.g. `getattr(config, "dgl_mode", False) will safely get
+# this variable from the module, defaulting to False if it doesn't exist (and
+# not raising an exception). `hasattr` is also safe.
+
+import logging
+import os
+
+import yaml
+
+try:
+    from collections import OrderedDict
+except ImportError:
+    from ordereddict import OrderedDict # type: ignore
+
+
+dgl_mode = True
+
+bind_nonsecure = True # Set to false to only use SSL
+bind_address = ""
+bind_port = 8080
+# Or listen on multiple address/port pairs (overriding the above) with:
+# bind_pairs = (
+#     ("127.0.0.1", 8080),
+#     ("localhost", 8082),
+#     ("", 8180), # All addresses
+# )
+
+logging_config = {
+#    "filename": "webtiles.log",
+    "level": logging.INFO,
+    "format": "%(asctime)s %(levelname)s: %(message)s"
+}
+
+password_db = "/data/webserver/passwd.db3"
+# Uncomment and change if you want this db somewhere separate from the
+# password_db location.
+settings_db = "/data/webserver/user_settings.db3"
+
+static_path = "./webserver/static"
+template_path = "./webserver/templates/"
+
+# Path for server-side unix sockets (to be used to communicate with crawl)
+server_socket_path = None # Uses global temp dir
+
+# Server name, so far only used in the ttyrec metadata
+server_id = ""
+
+# Disable caching of game data files
+game_data_no_cache = True
+
+# Watch socket dirs for games not started by the server
+watch_socket_dirs = False
+
+use_game_yaml = True
+
+# Game configs
+#
+# You can define game configs in two ways:
+# 1. With a static dictionary `games`
+# 2. As extra games to append to this list from `load_games.load_games` (which
+#    by default loads games as defined in `games.d/*.yaml`).
+#
+# All options in this config are documented in games.d/base.yaml.
+games = OrderedDict([
+    ("dcss-web-trunk", dict(
+        name = "Play trunk",
+        crawl_binary = "/app/bin/crawl",
+        rcfile_path = "/data/rcs/",
+        macro_path = "/data/rcs/",
+        morgue_path = "/data/rcs/%n",
+        inprogress_path = "/data/rcs/running",
+        ttyrec_path = "/data/rcs/ttyrecs/%n",
+        socket_path = "/data/rcs",
+        client_path = "/app/webserver/game_data/",
+        # dir_path = ".",
+        # cwd = ".",
+        morgue_url = None,
+        show_save_info = True,
+        milestone_path = "/data/rcs/milestones",
+        send_json_options = True,
+        # env = {"LANG": "en_US.UTF8"},
+        )),
+])
+
+
+dgl_status_file = "/data/rcs/status"
+
+# Extra paths to tail for milestone updates. This is a legacy setting, you
+# should use `milestone_path` or `dir_path` for each game in the games dict.
+# (This setting can be a string or list of strings.)
+milestone_file = ["./milestones"]
+
+status_file_update_rate = 5
+
+recording_term_size = (80, 24)
+
+max_connections = 100
+
+# Script to initialize a user, e.g. make sure the paths
+# and the rc file exist. This is not done by the server
+# at the moment.
+init_player_program = "./util/webtiles-init-player.sh"
+
+ssl_options = None # No SSL
+#ssl_options = {
+#    "certfile": "./webserver/localhost.crt",
+#    "keyfile": "./webserver/localhost.key"
+#}
+ssl_address = ""
+ssl_port = 8081
+# Or listen on multiple address/port pairs (overriding the above) with:
+# ssl_bind_pairs = (
+#     ("127.0.0.1", 8081),
+#     ("localhost", 8083),
+# )
+
+connection_timeout = 600
+max_idle_time = 5 * 60 * 60
+
+use_gzip = True
+
+# Seconds until stale HTTP connections are closed
+# This needs a patch currently not in mainline tornado.
+http_connection_timeout = None
+
+# Set this to true if you are behind a reverse proxy
+# Your proxy must set header X-Real-IP
+#
+# Enabling this option when webtiles is NOT protected behind a reverse proxy
+# introduces a security risk. An attacker could inject a false address into the
+# X-Real-IP header. Do not enable this option if the webtiles server is
+# directly exposed to users.
+http_xheaders = None
+
+kill_timeout = 10 # Seconds until crawl is killed after HUP is sent
+
+nick_regex = r"^[a-zA-Z0-9]{3,20}$"
+max_passwd_length = 20
+
+allow_password_reset = False # Set to true to allow users to request a password reset email. Some settings must be properly configured for this to work
+
+# Set to the primary URL where a player would reach the main lobby
+# For example: "http://crawl.akrasiac.org/"
+# This is required for for password reset, as it will be the base URL for
+# recovery URLs.
+lobby_url = None
+
+# Proper SMTP settings are required for password reset to function properly.
+# if smtp_host is anything other than `localhost`, you may need to adjust the
+# timeout settings (see server.py, calls to ioloop.set_blocking_log_threshold).
+# TODO: set_blocking_log_threshold is deprecated in tornado 5+...
+# Ideally, test out these settings carefully in a non-production setting
+# before enabling this, as there's a bunch of ways for this to go wrong and you
+# don't want to get your SMTP server blacklisted.
+smtp_host = "localhost"
+smtp_port = 25
+smtp_use_ssl = False
+smtp_user = "" # set to None for no auth
+smtp_password = ""
+smtp_from_addr = "noreply@crawl.example.org" # The address from which automated
+                                             # emails will be sent
+
+# crypt() algorithm, e.g. "1" for MD5 or "6" for SHA-512; see crypt(3). If
+# false, use traditional DES (but then only the first eight characters of the
+# password are significant). If set to "broken", use traditional DES with
+# the password itself as the salt; this is necessary for compatibility with
+# dgamelaunch, but should be avoided if possible because it leaks the first
+# two characters of the password's plaintext.
+crypt_algorithm = "broken"
+
+# The length of the salt string to use. If crypt_algorithm is false, this
+# setting is ignored and the salt is two characters.
+crypt_salt_length = 16
+
+login_token_lifetime = 7 # Days
+
+uid = None  # If this is not None, the server will setuid to that (numeric) id
+gid = None  # after binding its sockets.
+
+umask = None # e.g. 0077
+
+chroot = None
+
+pidfile = None
+daemon = False # If true, the server will detach from the session after startup
+
+# Set to a URL with %s where lowercased player name should go in order to
+# hyperlink WebTiles spectator names to their player pages.
+# For example: "http://crawl.akrasiac.org/scoring/players/%s.html"
+# Set to None to disable player page hyperlinks
+player_url = None
+
+# Only for development:
+# This is insecure; do not set development_mode = True in production!
+development_mode = False
+
+# Disable caching of static files which are not part of game data.
+no_cache = development_mode
+# Automatically log in all users with the username given here.
+autologin = None