From f412c3dd5b94b42965d5f38ffd9f364a84190f29 Mon Sep 17 00:00:00 2001 From: Hayden Date: Thu, 7 Jan 2021 19:54:17 -0900 Subject: [PATCH] added env variable --- docs/docs/getting-started/install.md | 1 + mealie/app.py | 10 ++++++++-- mealie/settings.py | 8 ++++++++ 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md index 7742622c1d9e..b5196d2b3f61 100644 --- a/docs/docs/getting-started/install.md +++ b/docs/docs/getting-started/install.md @@ -16,6 +16,7 @@ To deploy docker on your local network it is highly recommended to use docker to | db_password | example | The Mongodb password you specified in your mongo container | | db_host | mongo | The host address of MongoDB if you're in docker and using the same network you can use mongo as the host name | | db_port | 27017 | the port to access MongoDB 27017 is the default for mongo | +| api_docs | True | Turns on/off access to the API documentation locally. | | TZ | | You should set your time zone accordingly so the date/time features work correctly | diff --git a/mealie/app.py b/mealie/app.py index 8ff47ba54db3..cbbdc2d03529 100644 --- a/mealie/app.py +++ b/mealie/app.py @@ -15,13 +15,19 @@ from routes import ( user_routes, ) from routes.setting_routes import scheduler # ! This has to be imported for scheduling -from settings import PORT, PRODUCTION +from settings import PORT, PRODUCTION, docs_url, redoc_url from utils.logger import logger CWD = Path(__file__).parent WEB_PATH = CWD.joinpath("dist") -app = FastAPI() +app = FastAPI( + title="Mealie", + description="A place for all your recipes", + version="0.0.1", + docs_url=docs_url, + redoc_url=redoc_url, +) # Mount Vue Frontend only in production diff --git a/mealie/settings.py b/mealie/settings.py index 8a726d44efbe..9814edf739f2 100644 --- a/mealie/settings.py +++ b/mealie/settings.py @@ -10,6 +10,14 @@ dotenv.load_dotenv(ENV) # General PRODUCTION = os.environ.get("ENV") PORT = int(os.getenv("mealie_port", 9000)) +API = os.getenv("api_docs", True) + +if API: + docs_url = "/docs" + redoc_url = "/redoc" +else: + docs_url = None + redoc_url = None # Mongo Database MEALIE_DB_NAME = os.getenv("mealie_db_name", "mealie")