update docs

Author: vincentsarago

.github/workflows/deploy_mkdocs.yml

@@ -42,7 +42,8 @@ jobs:
             titiler.core.utils \
             titiler.core.routing \
             titiler.core.errors \
-            titiler.core.resources.enums
+            titiler.core.resources.enums \
+            titiler.core.middleware
 
           pdocs as_markdown \
             --output_dir docs/src/api \

.gitignore

@@ -107,4 +107,4 @@ ENV/
 
 cdk.out/
 deployment/k8s/titiler/values-test.yaml
-docs/api
+docs/src/api/

CONTRIBUTING.md

@@ -53,7 +53,8 @@ $ mkdocs gh-deploy -f docs/mkdocs.yml
    titiler.core.utils \
    titiler.core.routing \
    titiler.core.errors \
-   titiler.core.resources.enums
+   titiler.core.resources.enums \
+   titiler.core.middleware
 
    pdocs as_markdown \
    --output_dir docs/src/api \

docs/mkdocs.yml

@@ -69,7 +69,7 @@ nav:
       - routing: api/titiler/core/routing.md
       - errors: api/titiler/core/errors.md
       - enums: api/titiler/core/resources/enums.md
-
+      - middleware: api/titiler/core/middleware.md
     - titiler.mosaic:
       - factory: api/titiler/mosaic/factory.md
       - enums: api/titiler/mosaic/resources/enums.md

docs/src/intro.md

@@ -21,6 +21,20 @@ See default endpoints documentation pages:
 * [`/stac` - Spatio Temporal Asset Catalog](endpoints/stac.md)
 * [`/tms` - TileMatrixSets](endpoints/tms.md)
 
+#### Settings
+
+The default application can be customized using environment variables defined in `titiler.application.settings.ApiSettings` class. Each variable needs to be prefixed with `TITILER_API_`.
+
+- `NAME` (str): name of the application. Defaults to `titiler`.
+- `CORS_ORIGINS` (str, `,` delimited origins): allowed CORS origin. Defaults to `*`.
+- `CACHECONTROL` (str): Cache control header to add to responses. Defaults to `"public, max-age=3600"`.
+- `ROOT_PATH` (str): path behind proxy.
+- `DEBUG` (str): adds `LoggerMiddleware` and `TotalTimeMiddleware` in the middleware stack.
+- `DISABLE_COG` (bool): disable `/cog` endpoints.
+- `DISABLE_STAC` (bool): disable `/stac` endpoints.
+- `DISABLE_MOSAIC` (bool): disable `/mosaic` endpoints.
+- `LOWER_CASE_QUERY_PARAMETERS` (bool): transform all query-parameters to lower case (see https://github.com/developmentseed/titiler/pull/321).
+
 ## Development
 
 To install and run `Titiler` from sources and for developing the `Titiler` code itself: