Skip to content

Commit

Permalink
Fix typo and formatting in docs (#670)
Browse files Browse the repository at this point in the history
  • Loading branch information
JarnoRFB authored and Qwlouse committed Sep 25, 2019
1 parent b09a070 commit 84c373a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/examples.rst
Expand Up @@ -95,9 +95,13 @@ To ease getting started with these services you find an exemplary ``docker-compo
This will pull the necessary containers from the internet and build them. This may take several
minutes.
Afterwards mongoDB should be up and running. ``mongo-express``, an admin interface for MonogDB, should now
be available on port ``8081``, accessible by the user and password set in the ``.env`` file (``ME_CONFIG_BASICAUTH_USERNAME``
and ``ME_CONFIG_BASICAUTH_PASSWORD``). ``Sacredboard ``should be available on port ``5000``. ``Omniboard`` should be
available on port ``9000``. They will both listen to the the database name setted in the ``.env`` file (``MONGO_DATABASE``) which will allow the boards to listen to the appropriated mongo database name set when creating the MongoObserver with the ``db_name`` arg. All services will by default only be exposed to ``localhost``. If you want
be available on port ``8081``, accessible by the user and password set in the ``.env`` file
(``ME_CONFIG_BASICAUTH_USERNAME`` and ``ME_CONFIG_BASICAUTH_PASSWORD``).
``Sacredboard ``should be available on port ``5000``. ``Omniboard`` should be
available on port ``9000``. They will both listen to the the database name set
in the ``.env`` file (``MONGO_DATABASE``) which will allow the boards to listen to the appropriated
mongo database name set when creating the MongoObserver with the ``db_name`` arg.
All services will by default only be exposed to ``localhost``. If you want
to expose them on all interfaces, e.g. for the use on a server, you need to change the port mappings
in ``docker-compose.yml`` from ``127.0.0.1:XXXX:XXXX`` to ``XXXX:XXXX``. However, in this case you should
change the authentification information in ``.env`` to something more secure.
change the authentication information in ``.env`` to something more secure.

0 comments on commit 84c373a

Please sign in to comment.