Update README.md and sample values

thevickypedia · Sep 7, 2024 · ad142cd · ad142cd
1 parent 1d7d9e3
commit ad142cd
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -58,6 +58,10 @@ pyninja start
 - **WORKERS** - Number of workers for the uvicorn server.
 - **REMOTE_EXECUTION** - Boolean flag to enable remote execution.
 - **API_SECRET** - Secret access key for running commands on server remotely.
+- **MONITOR_USERNAME** - Username to authenticate the monitoring page.
+- **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
+- **MONITOR_SESSION** - Session timeout for the monitoring page.
+- **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
 - **DATABASE** - FilePath to store the auth database that handles the authentication errors.
 - **RATE_LIMIT** - List of dictionaries with `max_requests` and `seconds` to apply as rate limit.
 - **APIKEY** - API Key for authentication.

diff --git a/docs/README.html b/docs/README.html
@@ -95,6 +95,10 @@ <h2>Environment Variables<a class="headerlink" href="#environment-variables" tit
 <li><p><strong>WORKERS</strong> - Number of workers for the uvicorn server.</p></li>
 <li><p><strong>REMOTE_EXECUTION</strong> - Boolean flag to enable remote execution.</p></li>
 <li><p><strong>API_SECRET</strong> - Secret access key for running commands on server remotely.</p></li>
+<li><p><strong>MONITOR_USERNAME</strong> - Username to authenticate the monitoring page.</p></li>
+<li><p><strong>MONITOR_PASSWORD</strong> - Password to authenticate the monitoring page.</p></li>
+<li><p><strong>MONITOR_SESSION</strong> - Session timeout for the monitoring page.</p></li>
+<li><p><strong>SERVICE_MANAGER</strong> - Service manager filepath to handle the service status requests.</p></li>
 <li><p><strong>DATABASE</strong> - FilePath to store the auth database that handles the authentication errors.</p></li>
 <li><p><strong>RATE_LIMIT</strong> - List of dictionaries with <code class="docutils literal notranslate"><span class="pre">max_requests</span></code> and <code class="docutils literal notranslate"><span class="pre">seconds</span></code> to apply as rate limit.</p></li>
 <li><p><strong>APIKEY</strong> - API Key for authentication.</p></li>

diff --git a/docs/README.md b/docs/README.md
@@ -58,6 +58,10 @@ pyninja start
 - **WORKERS** - Number of workers for the uvicorn server.
 - **REMOTE_EXECUTION** - Boolean flag to enable remote execution.
 - **API_SECRET** - Secret access key for running commands on server remotely.
+- **MONITOR_USERNAME** - Username to authenticate the monitoring page.
+- **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
+- **MONITOR_SESSION** - Session timeout for the monitoring page.
+- **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
 - **DATABASE** - FilePath to store the auth database that handles the authentication errors.
 - **RATE_LIMIT** - List of dictionaries with `max_requests` and `seconds` to apply as rate limit.
 - **APIKEY** - API Key for authentication.

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -58,6 +58,10 @@ pyninja start
 - **WORKERS** - Number of workers for the uvicorn server.
 - **REMOTE_EXECUTION** - Boolean flag to enable remote execution.
 - **API_SECRET** - Secret access key for running commands on server remotely.
+- **MONITOR_USERNAME** - Username to authenticate the monitoring page.
+- **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
+- **MONITOR_SESSION** - Session timeout for the monitoring page.
+- **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
 - **DATABASE** - FilePath to store the auth database that handles the authentication errors.
 - **RATE_LIMIT** - List of dictionaries with `max_requests` and `seconds` to apply as rate limit.
 - **APIKEY** - API Key for authentication.

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/pyninja/models.py b/pyninja/models.py
@@ -192,7 +192,7 @@ class EnvConfig(BaseSettings):
     api_secret: str | None = None
     monitor_username: str | None = None
     monitor_password: str | None = None
-    monitor_session: PositiveInt = 10
+    monitor_session: PositiveInt = 3_600
     service_manager: FilePath | ServiceManager = get_service_manager()
     database: str = Field("auth.db", pattern=".*.db$")
     rate_limit: RateLimit | List[RateLimit] = []

diff --git a/pyninja/routers.py b/pyninja/routers.py
@@ -404,6 +404,7 @@ def get_all_routes() -> List[APIRoute]:
                 dependencies=dependencies,
             )
         )
+    # Conditional endpoint based on monitor_username and monitor_password
     if all((models.env.monitor_username, models.env.monitor_password)):
         routes.extend(monitor.get_all_monitor_routes(dependencies))
     return routes
diff --git a/release_notes.rst b/release_notes.rst
@@ -3,24 +3,28 @@ Release Notes
 
 v0.0.4 (09/06/2024)
 -------------------
-- Include an option to monitor system resources via websockets
+- Includes an option to monitor system resources via `WebSockets`
 
 v0.0.3 (08/16/2024)
 -------------------
-- Release `v0.0.3`
+- Allows env vars to be sourced from both ``env_file`` and ``kwargs``
 
 v0.0.2 (08/16/2024)
 -------------------
-- Release `v0.0.2`
+- Includes added support for custom log configuration
 
 v0.0.1 (08/11/2024)
 -------------------
-- Release `v0.0.1`
+- Includes a process monitor and remote command execution functionality
+- Security improvements including brute force protection and rate limiting
+- Accepts ``JSON`` and ``YAML`` files for env config
+- Supports custom worker count for ``uvicorn`` server
+- Allows custom logging using ``logging.ini``
+- Includes an option to set the ``apikey`` via commandline
 
 v0.0.0 (08/11/2024)
 -------------------
-- Implement concurrency for validating process health
-- Update logger names across the module and README.md
+- Release first stable version
 
 0.0.0-a (08/10/2024)
 --------------------

diff --git a/samples/.env b/samples/.env
@@ -3,6 +3,9 @@ NINJA_PORT=8005
 WORKERS=3
 REMOTE_EXECUTION=True
 API_SECRET="3A%3/[&1X>ARsz{hADFYI'}XhK4H)Gi~"
+MONITOR_USERNAME="username"
+MONITOR_PASSWORD="password"
+MONITOR_SESSION=3600
 DATABASE="auth_errors.db"
 RATE_LIMIT='[{"max_requests": 3, "seconds": 1}, {"max_requests": 10, "seconds": 3}]'
 APIKEY="MySecreatAccessToken"
diff --git a/samples/secrets.json b/samples/secrets.json
@@ -4,6 +4,9 @@
   "WORKERS": 3,
   "REMOTE_EXECUTION": true,
   "API_SECRET": "3A%3/[&1X>ARsz{hADFYI'}XhK4H)Gi~",
+  "MONITOR_USERNAME": "username",
+  "MONITOR_PASSWORD": "password",
+  "MONITOR_SESSION": 3600,
   "DATABASE": "auth_errors.db",
   "RATE_LIMIT": [
     {

diff --git a/samples/secrets.yaml b/samples/secrets.yaml
@@ -1,12 +1,15 @@
-NINJA_HOST: "0.0.0.0"
+NINJA_HOST: 0.0.0.0
 NINJA_PORT: 8005
 WORKERS: 3
 REMOTE_EXECUTION: true
 API_SECRET: "3A%3/[&1X>ARsz{hADFYI'}XhK4H)Gi~"
-DATABASE: "auth_errors.db"
+MONITOR_USERNAME: username
+MONITOR_PASSWORD: password
+MONITOR_SESSION: 3600
+DATABASE: auth_errors.db
 RATE_LIMIT:
   - max_requests: 3
     seconds: 1
   - max_requests: 10
     seconds: 3
-APIKEY: "MySecreatAccessToken"
+APIKEY: MySecreatAccessToken