Skip to content

Commit

Permalink
Link cleanup, start work on Configuration Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
aramperes committed Apr 16, 2018
1 parent 2c9328c commit 4c29730
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 5 deletions.
11 changes: 11 additions & 0 deletions Configuration_Guide/glowstone_yml/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
glowstone.yml
=============

The :code:`glowstone.yml` file allows you to edit your server settings.

.. toctree::
:maxdepth: 2
:caption: Sections
:titlesonly:

server
17 changes: 17 additions & 0 deletions Configuration_Guide/glowstone_yml/server.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
server
======

+--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
| Key | Type | Default | Description |
+================================+===================+================================+=============================================================+
| ip | string | | Which interface the server should listen on, usually blank. |
+--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
| port | integer | 25565 | The port the server should listen on. |
+--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
| name | string | Glowstone Server | The server's name, used in queries. |
+--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
| log-file | string | logs/log-%D.txt | Where the log is stored relative to the server folder. |
+--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
| | | | Whether connecting players are authenticated. |
| online-mode | true/false | true | Only disable this if you know what you are doing. |
+--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
21 changes: 21 additions & 0 deletions Configuration_Guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Configuration Guide
###################

The YAML files allow you to edit your server settings.
They can be found in the :code:`config` directory in your server installation.

After modifying your configuration files, you will need to restart your server to apply the changes.

.. tip::

If you want the server to simply generate/validate configuration files without starting the server, you can use the
:code:`--generate-config` command-line argument.

Simply add the argument at the end of the :code:`java [...] -jar glowstone.jar` line inside your startup script.

.. toctree::
:maxdepth: 2
:caption: Contents
:titlesonly:

glowstone_yml/index
4 changes: 1 addition & 3 deletions FAQ/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ Failed to bind to address. Maybe it is already in use?
**This error means that you've already got a server running on the port that you've configured.**

More information can be found in the "Server Binding" subsection inside the `First Run`_ section.

.. _`First Run`: ../Getting_Started/first_run.html#bind-fail-error
More information can be found in the :ref:`Server Binding` subsection inside the First Run section.

Unsupported major.minor version
-------------------------------
Expand Down
3 changes: 1 addition & 2 deletions Getting_Started/first_run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Server Binding
--------------

Once it is ready, the server will open itself on a TCP port. By default, this is port :code:`25565`, and can be
changed in the server configuration. For more information, refer to the `Configuration Guide`_ section.
changed in the server configuration. For more information, refer to the :doc:`../Configuration_Guide/index` section.

.. code-block:: none
Expand All @@ -86,7 +86,6 @@ changed in the server configuration. For more information, refer to the `Configu
Once the "Ready for connections." line is output, your server should be reachable by clients.

.. error::
:name: bind-fail-error

**Failed to bind to address. Maybe it is already in use?**

Expand Down
4 changes: 4 additions & 0 deletions _static/glowstone.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/* Prevents scrollbar in tables */
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal;
}
3 changes: 3 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -157,3 +158,5 @@


# -- Extension configuration -------------------------------------------------
def setup(app):
app.add_stylesheet('glowstone.css')
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ Table of Contents
Why_Glowstone/index
Getting_Started/index
FAQ/index
Configuration_Guide/index

0 comments on commit 4c29730

Please sign in to comment.