From 1e5db4d700b72943c88d9a4480ab4ff2d032f3aa Mon Sep 17 00:00:00 2001 From: Alexis VIALARET Date: Wed, 21 Feb 2024 23:19:36 +0100 Subject: [PATCH] fix: doc --- docs/deployment/admin_mode.md | 8 ++++++++ mkdocs.yml | 2 ++ 2 files changed, 10 insertions(+) create mode 100644 docs/deployment/admin_mode.md diff --git a/docs/deployment/admin_mode.md b/docs/deployment/admin_mode.md new file mode 100644 index 0000000..e24ef06 --- /dev/null +++ b/docs/deployment/admin_mode.md @@ -0,0 +1,8 @@ +Once you start deploying to a cloud, you may end up having to publicly expose your backend and frontend to the internet. In this case you will need to disable the admin mode on the deployed components. + +Just deploy with the `ADMIN_MODE` env var as disabled. This could be in your Dockerfile, or any other deployment config. +```shell +ADMIN_MODE=0 +``` + +This will disable the signup endpoint, preventing people stumbling upon the API from creating an account and using your LLM tokens. diff --git a/mkdocs.yml b/mkdocs.yml index fd9470b..c88d261 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,3 +18,5 @@ nav: - Home: index.md - The frontend: frontend.md - The database: database.md + - Deployment: + - Admin Mode: deployment/admin_mode.md