Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use environment variable to define configuration file path #257

Merged
merged 2 commits into from
Nov 26, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update documentation to explain the new environment variable and corr…
…ect a few typos.
  • Loading branch information
jimdoescode committed Mar 20, 2018
commit f8746473046c5c1f2ca0bbb766017a274778c0b6
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,11 @@ For detaile information, see `theme usage and customization`_.
Config explanation
^^^^^^^^^^^^^^^^^^

Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the `default config`_ to solve format problems.
Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config. If you mess up the JSON format the app will still work but you'll need to overwrite your custom config with the `default config`_ to solve format problems.

You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
If you would like to specify a different location for your custom config you can set the ``RAINBOW_CONFIG`` environment variable to the location of your custom config.

You also can view or set a new value of every config key with the ``config`` command (See **Interactive mode** section above).

- ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.

Expand Down