From 98350e294148a2a066e47fbd12522f4ded7e9f4b Mon Sep 17 00:00:00 2001 From: laurenceisla Date: Mon, 9 Aug 2021 18:06:45 -0500 Subject: [PATCH] Update docker configuration --- configuration.rst | 20 ++++++++++---------- install.rst | 15 ++------------- releases/v8.0.0.rst | 3 +++ 3 files changed, 15 insertions(+), 23 deletions(-) diff --git a/configuration.rst b/configuration.rst index b758b1265..5b6a28e37 100644 --- a/configuration.rst +++ b/configuration.rst @@ -32,6 +32,8 @@ The configuration file must contain a set of key value pairs. At minimum you mus The user specified in the db-uri is also known as the authenticator role. For more information about the anonymous vs authenticator roles see the :ref:`roles`. +.. _config_full_list: + Here is the full list of configuration parameters. ======================== ======= ================= ======== @@ -65,8 +67,6 @@ role-claim-key String .role raw-media-types String ======================== ======= ================= ======== -You can also set these configuration parameters using environment variables. They are capitalized, have a ``PGRST_`` prefix, and use underscores. For example: ``PGRST_DB_URI`` corresponds to ``db-uri``. - .. _db-uri: db-uri @@ -386,6 +386,13 @@ raw-media-types raw-media-types="image/png, text/xml" +.. _env_variables_config: + +Environment Variables +===================== + +You can also set these :ref:`configuration parameters ` using environment variables. They are capitalized, have a ``PGRST_`` prefix, and use underscores. For example: ``PGRST_DB_URI`` corresponds to ``db-uri`` and ``PGRST_APP_SETTINGS_*`` to ``app.settings.*``. + .. _config_reloading: Configuration Reloading @@ -397,14 +404,7 @@ To reload the configuration without restarting the PostgREST server, send a SIGU killall -SIGUSR2 postgrest -To reload the config in docker: - -.. code:: bash - - docker kill -s SIGUSR2 - - # or in docker-compose - docker-compose kill -s SIGUSR2 +This method does not reload :ref:`env_variables_config` and it will not work for reloading a Docker container configuration. In these cases, you need to restart the PostgREST server or use :ref:`in_db_config` as an alternative. .. important:: diff --git a/install.rst b/install.rst index 6a682d8fd..afe50b6e8 100644 --- a/install.rst +++ b/install.rst @@ -99,19 +99,7 @@ You can get the `official PostgREST Docker image `_. |br| -- `@monacoremo `_ +* The Docker image no longer has an internal ``/etc/postgrest.conf`` file, you must use :ref:`env_variables_config` to configure it. + |br| -- `@wolfgangwalther `_ + * The ``pg_listen`` `utility `_ is no longer needed to automatically reload the schema cache and it's replaced entirely by database notifications. See :ref:`schema_reloading_notify`. |br| -- `@steve-chavez `_