added appendix in the documentation for environment variable settings

Author: tik65536

docs/source/appendix/index.rst

@@ -0,0 +1,38 @@
+Appendix 
+========
+
+Environment variables used by pydggsapi
+---------------------------------------
+
+Mandatory
+~~~~~~~~~
+
+============================== =========================================== ===============================
+Environment variable name      Defautl value                               Description
+============================== =========================================== ===============================
+DGGS_API_CONFIG                No default, mandatory                       Path to pydggsapi configration
+============================== =========================================== ===============================
+
+Optional
+~~~~~~~~~
+============================== =========================================== ===============================
+Environment variable name      Defautl value                               Description
+============================== =========================================== ===============================
+WORKERS                        4                                           Uvicorn number of workers
+BIND                           0.0.0.0:8000                                Uvicorn binding address
+DGGS_PREFIX                    /dggs-api                                   pydggsapi url prefix
+TILES_PREFIX                   /tiles-api                                  pydggsapi MVT tiles url prefix
+API_TITLE                      University of Tartu, OGC DGGS API v1-pre    FastAPI title
+API_DESCRIPTION                OGC DGGS API                                FastAPI description
+ROOT_PATH                      None                                        FastAPI root_path
+OPENAPI_URL                    /openapi.json                               FastAPI openapi path
+DOCS_URL                       /docs                                       FastAPI docs url
+SWAGGER_UI_OAUTH2_REDIRECT_URL /docs/oauth2-redirect                       FastAPI openapi aith redirect url
+CORS                           ["http://localhost"]                        FastAPI Cross-origin resource sharing
+GZIP_ENABLED                   True                                        FastAPI enable Gzip compression
+GZIP_COMPRESS_LEVEL            5                                           FastAPI Gzip compress level
+GZIP_MINIMUM_SIZE              500                                         FastAPI minimum size for compression
+REDOC_URL                      /redoc
+DGGRID_PATH                    None                                        Path to dggrid executable, only use with IGEO7DGGRSProvider
+============================== =========================================== ===============================
+

docs/source/index.rst

@@ -33,3 +33,4 @@ OGC API - DGGS specifies an API for accessing data organised according to a Disc
    providers/index
    pydggsapi demo notebook <example_notebook/pydggsapi_demo_notebook.ipynb>
    API endpoints examples <example_notebook/Endpoints_Examples.ipynb>
+   Appendix <appendix/index>

docs/source/introduction.rst

@@ -44,6 +44,8 @@ or install the latest updates from GitHub (under the same virtual environment of
     DGGS_API_CONFIG=<Path to TinyDB>
     DGGRID_PATH=<Path to dggrid executable>
 
+Users can control some pydggsapi settings through environment variables, such as ``DGGS_PREFIX`` to set the pydggsapi prefix for reverse proxy configuration. Users can refer to the :doc:`Appendix </appendix/index>` for more information. 
+
 3. Start the server:
 
 .. code-block:: bash
@@ -56,7 +58,7 @@ Docker build
 
 We have now a Dockerfile (thanks to CRIM/https://github.com/fmigneault) that allows you to easily build and run pydggsapi in a containerized environment.
 
-You can build the docker image using the following command:
+You can build the docker image using the following command at the repository root diretory:
 
 .. code-block:: bash
 
@@ -93,7 +95,7 @@ In order to work with IGEO7 (using `DGGRID <https://github.com/sahrk/DGGRID>`_),
 
 .. code-block:: bash
     
-    dggs_api_config=<Path to TinyDB>
+    DGGS_API_CONFIG=<Path to TinyDB>
     DGGRID_PATH=<Path to dggrid executable>
 
 4. Start the server: