docs: replace API_KEY_PEPPER envvar by SECRET_PEPPER (conflict with load_dotenv svc method who extract by pattern 'API_KEY_*')

Author: Athroniaeth

README.md

@@ -126,7 +126,7 @@ from fastapi_api_key import ApiKeyService
 from fastapi_api_key.hasher.argon2 import Argon2ApiKeyHasher
 from fastapi_api_key.repositories.in_memory import InMemoryApiKeyRepository
 
-pepper = os.environ["API_KEY_PEPPER"]
+pepper = os.environ["SECRET_PEPPER"]
 hasher = Argon2ApiKeyHasher(pepper=pepper)
 
 repo = InMemoryApiKeyRepository()
@@ -186,7 +186,7 @@ from fastapi_api_key.api import create_api_keys_router, create_depends_api_key
 # Set env var to override default pepper
 # Using a strong, unique pepper is crucial for security
 # Default pepper is insecure and should not be used in production
-pepper = os.getenv("API_KEY_PEPPER")
+pepper = os.getenv("SECRET_PEPPER")
 hasher = Argon2ApiKeyHasher(pepper=pepper)
 
 path = Path(__file__).parent / "db.sqlite3"

docs/usage/cache.md

@@ -49,7 +49,7 @@ service = CachedApiKeyService(repo=repo, hasher=hasher, cache=redis_cache, cache
 This is the canonical example from `examples/example_cached.py`:
 
 !!! warning "Always set a pepper"
-    The default pepper is a placeholder. Set `API_KEY_PEPPER` (or pass it explicitly to the hashers) in every environment.
+    The default pepper is a placeholder. Set `SECRET_PEPPER` (or pass it explicitly to the hashers) in every environment.
 
 ```python
 --8<-- "examples/example_cached.py"

docs/usage/database.md

@@ -15,7 +15,7 @@ pip install fastapi-api-key[sqlalchemy]
 This is the canonical example from `examples/example_sql.py`:
 
 !!! warning "Always set a pepper"
-    The default pepper is a placeholder. Set `API_KEY_PEPPER` (or pass it explicitly to the hashers) in every environment.
+    The default pepper is a placeholder. Set `SECRET_PEPPER` (or pass it explicitly to the hashers) in every environment.
 
 ```python
 --8<-- "examples/example_sql.py"

docs/usage/dotenv.md

@@ -13,7 +13,7 @@ API_KEY_DEV=ak-dcde9fa8eec44aa2-n8JK2HPXoosH6UXPL5h2YeO3OdW55WESb97CKc7mbVUzFpWF
 This is the canonical example from `examples/example_inmemory_env.py`:
 
 !!! warning "Always set a pepper"
-    The default pepper is a placeholder. Set `API_KEY_PEPPER` (or pass it explicitly to the hashers) in every environment.
+    The default pepper is a placeholder. Set `SECRET_PEPPER` (or pass it explicitly to the hashers) in every environment.
 
 ```python
 --8<-- "examples/example_inmemory_env.py"

docs/usage/fastapi.md

@@ -14,7 +14,7 @@ together using FastAPI dependency injection.
 This is the canonical example from `examples/example_fastapi.py`:
 
 !!! warning "Always set a pepper"
-    The default pepper is a placeholder. Set `API_KEY_PEPPER` (or pass it explicitly to the hashers) in every environment.
+    The default pepper is a placeholder. Set `SECRET_PEPPER` (or pass it explicitly to the hashers) in every environment.
 
 ```python
 --8<-- "examples/example_fastapi.py"

docs/usage/scopes.md

@@ -10,7 +10,7 @@ If you define 2 scopes "read" and "write" to an route, an API key must have both
 This is the canonical example from `examples/example_scopes.py`:
 
 !!! warning "Always set a pepper"
-    The default pepper is a placeholder. Set `API_KEY_PEPPER` (or pass it explicitly to the hashers) in every environment.
+    The default pepper is a placeholder. Set `SECRET_PEPPER` (or pass it explicitly to the hashers) in every environment.
 
 ```python
 --8<-- "examples/example_scopes.py"

docs/usage/typer.md

@@ -14,7 +14,7 @@ together using Typer dependency injection.
 This is the canonical example from `examples/example_cli.py`.
 
 !!! warning "Always set a pepper"
-    The default pepper is a placeholder. Set `API_KEY_PEPPER` (or pass it explicitly to the hashers) in every environment.
+    The default pepper is a placeholder. Set `SECRET_PEPPER` (or pass it explicitly to the hashers) in every environment.
 
 ```python
 --8<-- "examples/example_cli.py"

examples/example_cached.py

@@ -12,7 +12,7 @@
 # Set env var to override default pepper
 # Using a strong, unique pepper is crucial for security
 # Default pepper is insecure and should not be used in production
-pepper = os.getenv("API_KEY_PEPPER", "change_me")
+pepper = os.getenv("SECRET_PEPPER")
 hasher = Argon2ApiKeyHasher(pepper=pepper)
 
 # default hasher is Argon2 with a default pepper (to be changed in prod)

examples/example_cli.py

@@ -21,7 +21,7 @@ class ApiKeyModel(Base, ApiKeyModelMixin): ...
 # Set env var to override default pepper
 # Using a strong, unique pepper is crucial for security
 # Default pepper is insecure and should not be used in production
-pepper = os.getenv("API_KEY_PEPPER")
+pepper = os.getenv("SECRET_PEPPER")
 hasher = Argon2ApiKeyHasher(pepper=pepper)
 
 path = Path(__file__).parent / "db.sqlite3"

examples/example_fastapi.py

@@ -13,7 +13,7 @@
 # Set env var to override default pepper
 # Using a strong, unique pepper is crucial for security
 # Default pepper is insecure and should not be used in production
-pepper = os.getenv("API_KEY_PEPPER")
+pepper = os.getenv("SECRET_PEPPER")
 hasher = Argon2ApiKeyHasher(pepper=pepper)
 
 path = Path(__file__).parent / "db.sqlite3"