Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
Refer to the settings that are now documented more comprehensively.
Enhance formatting.
  • Loading branch information
oh2fih committed Aug 11, 2024
1 parent 9fa49ff commit 6b8c6d2
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ interact with objects rather then with raw data.

Dependencies
------------

As stated you will need to have one of two things; in order to fully use this package you need access to:

* A cve-search mongodb instance
* MongoDB; either an empty or an already populated cve-search mongodb instance

OR

Expand Down Expand Up @@ -68,23 +69,27 @@ Or simple install all modules:
Documentation
-------------
Check `github pages documentation <https://cve-search.github.io/CveXplore/>`_

Check `github pages documentation <https://cve-search.github.io/CveXplore/>`_.

Most of the following configuration including the configuration directory path can be altered using
`settings <https://cve-search.github.io/CveXplore/general/settings.html>`_ from environment variables.

General
-------

Configuration
*************

CveXplore automatically creates a config folder in '~/.cvexplore'. CveXplore stores several configuration
files in here such as the .env for general configuration and the .sources.ini for data sources configuration.
CveXplore automatically creates a config folder in ``~/.cvexplore``. CveXplore stores several configuration
files in here such as the ``.env`` for general configuration and the ``.sources.ini`` for data sources configuration.

Logging
*******

CveXplore stores all logs in the '~/.cvexplore/log' folder:
CveXplore stores all logs in the ``~/.cvexplore/log`` folder:

* update_populate.log; logging produced during database updates and database initialization.
* ``update_populate.log``; logging produced during database updates and database initialization.

Local Database populate / update
********************************
Expand Down

0 comments on commit 6b8c6d2

Please sign in to comment.