From 209b70cbfca8b23f7cf0f0b8b9d5822079e6aeff Mon Sep 17 00:00:00 2001
From: Laurence Isla <lau.isla.c@gmail.com>
Date: Wed, 25 May 2022 17:29:52 -0500
Subject: [PATCH] Add disclaimer on $ usage in jwt-secret values (#543)

---
 docs/configuration.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/configuration.rst b/docs/configuration.rst
index 9d2a33619..66061904b 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -480,6 +480,10 @@ jwt-secret
 
   Choosing a value for this parameter beginning with the at sign such as ``@filename`` (e.g. ``@./configs/my-config``) loads the secret out of an external file.
 
+  .. warning::
+
+     Only when using the :ref:`file_config`, if the ``jwt-secret`` contains a ``$`` character by itself it will give errors. In this case, use ``$$`` and PostgREST will interpret it as a single ``$`` character.
+
 .. _jwt-secret-is-base64:
 
 jwt-secret-is-base64