g0ldyy/comet
1
0
Fork 0
mirror of https://github.com/g0ldyy/comet.git synced 2026-01-12 01:16:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #430 from g0ldyy/development

Browse Source 
docs: clarify `.env` file setup instructions and add a warning for `FASTAPI_WORKERS` configuration
This commit is contained in:
Goldy
2026-01-02 15:11:26 +01:00
committed by GitHub
parent 4bc1f4aa7c e4be5546a2
commit 1f13e76ef0
2 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env-sample
+6 -1
View File
@@ -5,9 +5,14 @@
# ██║ ██║ ██║██║╚██╔╝██║██╔══╝ ██║ #
# ╚██████╗╚██████╔╝██║ ╚═╝ ██║███████╗ ██║ #
# ╚═════╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝ ╚═╝ #
#=================================================#
# Thank you for using Comet! 🚀 #
#=================================================#
# ⚠️ IMPORTANT: DO NOT copy the entire content of this file to your .env file.
# Only copy and modify the variables you need to change.
# The default values shown in this file are automatically loaded by Comet.
# ============================== #
# Stremio Addon Configuration #
# ============================== #
@@ -19,7 +24,7 @@ ADDON_NAME=Comet
# ============================== #
FASTAPI_HOST=0.0.0.0
FASTAPI_PORT=8000
FASTAPI_WORKERS=1 # set to -1 for auto-scaling (min((os.cpu_count() or 1) * 2 + 1, 12))
FASTAPI_WORKERS=1 # DO NOT change this if you don't know what you are doing. Setting this to -1 will spawn a worker for each CPU core, which can consume several GBs of RAM and cause high CPU usage.
USE_GUNICORN=True # Will use uvicorn if False or if on Windows
GUNICORN_PRELOAD_APP=True # Set to False to start workers without preloading the app (reduces startup cost but requires schema to exist)
README.md
+1 -1
View File
@@ -51,7 +51,7 @@ ElfHosted offer "one-click" [private Comet instances](https://elfhosted.com/app/
### With Docker Compose
- Copy *deployment/docker-compose.yml* in a directory
- Copy *.env-sample* to *.env* in the same directory and keep only the variables you wish to modify, also remove all comments
- Create a `.env` file in the same directory and add only the variables you wish to modify. All other variables will use the default values from `.env-sample`.
- Pull the latest version from docker hub
```sh
docker compose pull