Add FAQ, new config option.

index.rst

@@ -13,6 +13,7 @@ API and providing unparalleled scalability.
    users/getting-started
    users/configuration
    users/player-info-forwarding
+   users/frequently-asked-questions
 
 .. toctree::
    :maxdepth: 2

users/configuration.rst

@@ -93,6 +93,13 @@ These settings mostly cover the basic, most essential settings of the proxy.
 |                           |            |          | ``0`` means no compression and ``9``   |
 |                           |            |          | indicates maximum compression.         |
 +---------------------------+------------+----------+----------------------------------------+
+| ``login-ratelimit``       | Integer    | ``3000`` | This setting determines the minimum    |
+|                           |            |          | amount of time (in milliseconds) that  |
+|                           |            |          | must pass before a connection from the |
+|                           |            |          | same IP address will be accepted by    |
+|                           |            |          | the proxy. A value of ``0`` disables   |
+|                           |            |          | the rate limit.                        |
++---------------------------+------------+----------+----------------------------------------+
 
 ``query`` section
 ^^^^^^^^^^^^^^^^^
@@ -163,6 +170,10 @@ Below is the default configuration file for Velocity, ``velocity.toml``.
     # How much compression should be done (from 0-9). The default is -1, which uses zlib's default level of 6.
     compression-level = -1
 
+    # How fast (in miliseconds) are clients allowed to connect after the last connection? Default: 3000
+    # Disable by setting to 0
+    login-ratelimit = 3000
+
     [query]
     # Whether to enable responding to GameSpy 4 query responses or not
     enabled = false

users/frequently-asked-questions.rst

@@ -0,0 +1,56 @@
+Frequently asked questions
+==========================
+
+What versions of Minecraft does Velocity support?
+-------------------------------------------------
+
+Velocity supports Minecraft 1.8-1.13. It is important to note, however, that
+Velocity does not translate between protocol versions - most packets from
+the client and server are passed through the proxy unchanged. If you need
+a multi-protocol solution for your Minecraft server, please consider installing
+`ProtocolSupport <https://www.spigotmc.org/resources/protocolsupport.7201/>`_
+or `ViaVersion <https://www.spigotmc.org/resources/viaversion.19254/>`_
+on your backend servers.
+
+What server software is supported by Velocity?
+----------------------------------------------
+
+Velocity aims to support Paper, Sponge, and Minecraft Forge. As of August 13,
+2018, no Forge support currently exists and the server has been most extensively
+tested against Paper.
+
+What is Velocity's performance profile?
+---------------------------------------
+
+On a Velocity server without plugins, most CPU time is spent processing packets
+(especially decompressing and recompressing) and waiting on network events.
+Velocity has been tuned for throughput: given enough resources, a single proxy
+should be able to handle a large number of Minecraft players online.
+
+There are several ways to increase the throughput of the proxy.
+
+Keep an eye on your plugins
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The most important performance killer by far are your plugins! Velocity implements
+several measures to attempt to reduce issues caused by misbehaving plugins, but
+these measures are imperfect. It is important you monitor your plugins to ensure
+they are not hurting your proxy throughput.
+
+Disable compression between the proxy and your backend server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If your backend server has compression enabled (by default, Minecraft servers
+compress packets larger than 256 bytes), then Velocity is forced to do additional
+decompression to process packets going through the proxy. The best solution is to
+disable compression on your backend server, so that only Velocity is responsible for
+compressing packets.
+
+To disable compression, simply set ``network-compression-threshold=-1`` in your
+``server.properties``, and then reboot your server.
+
+Keep up to date
+^^^^^^^^^^^^^^^
+
+The Velocity team constantly seeks to improve the throughput of the proxy, and
+you can only benefit from our efforts if you keep the proxy regularly up-to-date.