Skip to content

Commit

Permalink
docs: corrected table formatting and minor typos (#688)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fozy81 @gr2m
fozy81 authored and gr2m committed Feb 11, 2017
1 parent f6dcd1d commit 064b1cc
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions docs/guides/configuration.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,35 @@ Options

Here is a list of all available options

+-----------------+--------------------------+--------------------------+--------------------------+--------------------------------------------------------------------------------------------------------------------+
| Option | Default value | CLI argument | ENV variable | description |
+=================+==========================+==========================+==========================+====================================================================================================================+
| address | ``'127.0.0.1'`` | ``--address`` | ``hoodie_address`` | Address to which Hoodie binds |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| data | ``'.hoodie'`` | ``--data`` | ``hoodie_data`` | Data path |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| dbUrl | – | ``--dbUrl`` | ``hoodie_dbUrl`` | If provided, uses external CouchDB. URL has to contain credentials. Sets ``dbAdapter`` to ``pouchdb-adapter-http`` |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| dbAdapter | ``'pouchdb-adapter-fs'`` | ``--dbAdapter`` | ``hoodie_dbAdapter`` | Sets default `PouchDB adapter <https://pouchdb.com/adapters.html>` unless ``inMemory`` or ``dbUrl`` set |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| loglevel | ``'warn'`` | ``--loglevel`` | ``hoodie_loglevel`` | One of: silent, error, warn, http, info, verbose, silly |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| inMemory | ``false`` | ``-m``, ``--inMemory`` | ``hoodie_inMemory`` | Whether to start the PouchDB Server in memory. Sets ``dbAdapter`` to ``pouchdb-adapter-memory`` |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| port | ``8080`` | ``--port`` | ``hoodie_port`` | Port-number to run the Hoodie App on |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| public | ``'public'`` | ``--public`` | ``hoodie_public`` | path to static assets |
+-----------------+--------------------------+--------------------------+------------+----------------------------------------------------------------------------------------------------------------------------------+
| url | - | ``--url`` | ``hoodie_url`` | Optional: external URL at which Hoodie Server is accessible (e.g. ``http://myhoodieapp.com``) |
+-----------------+--------------------------+--------------------------+--------------------------+--------------------------------------------------------------------------------------------------------------------+
| adminPassword | - | ``--adminPassword`` | ``hoodie_adminPassword`` | Password to login to Admin Dashboard. Login is not possible unless set |
+-----------------+--------------------------+--------------------------+--------------------------+--------------------------------------------------------------------------------------------------------------------+

+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| Option | Default value | CLI argument | ENV variable | description |
+=================+==========================+==========================+==========================+=====================================================================================================================+
| address | ``'127.0.0.1'`` | ``--address`` | ``hoodie_address`` | Address to which Hoodie binds |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| data | ``'.hoodie'`` | ``--data`` | ``hoodie_data`` | Data path |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| dbUrl | – | ``--dbUrl`` | ``hoodie_dbUrl`` | If provided, uses external CouchDB. URL has to contain credentials. Sets ``dbAdapter`` to ``pouchdb-adapter-http`` |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| dbAdapter | ``'pouchdb-adapter-fs'`` | ``--dbAdapter`` | ``hoodie_dbAdapter`` | Sets default `PouchDB adapter <https://pouchdb.com/adapters.html>` unless ``inMemory`` or ``dbUrl`` set |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| loglevel | ``'warn'`` | ``--loglevel`` | ``hoodie_loglevel`` | One of: silent, error, warn, http, info, verbose, silly |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| inMemory | ``false`` | ``-m``, ``--inMemory`` | ``hoodie_inMemory`` | Whether to start the PouchDB Server in memory. Sets ``dbAdapter`` to ``pouchdb-adapter-memory`` |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| port | ``8080`` | ``--port`` | ``hoodie_port`` | Port-number to run the Hoodie App on |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| public | ``'public'`` | ``--public`` | ``hoodie_public`` | path to static assets |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| url | - | ``--url`` | ``hoodie_url`` | Optional: external URL at which Hoodie Server is accessible (e.g. ``http://myhoodieapp.com``) |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
| adminPassword | - | ``--adminPassword`` | ``hoodie_adminPassword`` | Password to login to Admin Dashboard. Login is not possible unless set |
+-----------------+--------------------------+--------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------+
Defaults
--------

Default options are set in your app’s ``package.json`` file, using the
``"hoodie"`` key. Here is an example with all avaialble options and their
``"hoodie"`` key. Here is an example with all available options and their
default values

.. code:: json
Expand Down Expand Up @@ -75,7 +75,7 @@ To pass CLI options when starting Hoodie, you have to separate them with ``--``,
$ npm start -- --port=8090 --inMemory
All environment varibales are prefixed with ``hoodie_``. So to set the port to
All environment variables are prefixed with ``hoodie_``. So to set the port to
``8090`` and to start Hoodie in memory mode, you have to

- set the ``hoodie_port`` environment variable to ``8090``
Expand All @@ -88,7 +88,7 @@ Environment variables are prefixed with ``hoodie_``.
The priority of configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. command line arguments
1. Command line arguments
2. Environment variables
3. ``.hoodierc`` files
4. Your app’s defaults form the ``"hoodie"`` key in ``"package.json"``
Expand Down

0 comments on commit 064b1cc

Please sign in to comment.