Skip to content

Commit

Permalink
Minor adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
zaidka committed Jun 24, 2019
1 parent 16dce4f commit 1ef6b5a
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 22 deletions.
6 changes: 0 additions & 6 deletions docs/configuration.rst

This file was deleted.

6 changes: 6 additions & 0 deletions docs/environment-variables.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _environment-variables:

Environment Variables
=====================

TODO
6 changes: 6 additions & 0 deletions docs/https.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _https:

HTTPS
=====

TODO
11 changes: 8 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
Welcome to GenieACS's documentation!
====================================

.. toctree::
:caption: Table of Contents

.. raw:: latex

\part{Installation}
Expand All @@ -14,8 +17,8 @@ Welcome to GenieACS's documentation!
:maxdepth: 1
:caption: Installation

installation
configuration
installation-guide
environment-variables

.. raw:: latex

Expand Down Expand Up @@ -47,4 +50,6 @@ Welcome to GenieACS's documentation!
:maxdepth: 1
:caption: Security

security
https
cpe-authentication
roles-and-permissions
14 changes: 7 additions & 7 deletions docs/installation.rst → docs/installation-guide.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Installation
=============
Installation Guide
==================

This guide is for installing GenieACS on a single server on any Linux distro
that uses *systemd* as its init system.
Expand All @@ -10,9 +10,9 @@ a load-balancing/failover setup.

.. attention::

For production deployments make sure to configure SSL and change
``UI_JWT_SECRET`` to a unique and secure string. Refer to :ref:`security`
section for details.
For production deployments make sure to configure TLS and change
``UI_JWT_SECRET`` to a unique and secure string. Refer to :ref:`https`
section for how to enable TLS to encrypt traffic.

Prerequisites
-------------
Expand Down Expand Up @@ -63,8 +63,8 @@ Configure systemd
Create the file :file:`/opt/genieacs/genieacs.env` to hold our configuration
options which we pass to GenieACS as environment variables. See
:ref:`configuration` section for a list of all available configuration
options.
:ref:`environment-variables` section for a list of all available
configuration options.

.. code:: bash
Expand Down
6 changes: 0 additions & 6 deletions docs/security.rst

This file was deleted.

0 comments on commit 1ef6b5a

Please sign in to comment.