Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed Sep 29, 2024
1 parent 9c54523 commit dfaa0e1
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 13 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,24 @@ pyninja start
> _By default, `PyNinja` will look for a `.env` file in the current working directory._
</details>
- **APIKEY** - API Key for authentication.
- **NINJA_HOST** - Hostname for the API server.
- **NINJA_PORT** - Port number for the API server.
- **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.
- **MAX_CONNECTIONS** - Maximum number of monitoring sessions allowed in parallel.
- **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
- **PROCESSES** - List of process names to include in the monitor page.
- **SERVICES** - List of service names to include in the monitor page.
- **GPU_LIB** - GPU library filepath to use for monitoring.
- **DISK_LIB** - Disk library filepath to use for monitoring.
- **SERVICE_LIB** - Memory library filepath to use for monitoring.
- **PROCESSOR_LIB** - Processor library filepath to use for monitoring.
- **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.
- **LOG_CONFIG** - Logging configuration file path.

⚠️ Enabling remote execution can be extremely risky and a major security threat.
So use **caution** and set the **API_SECRET** to a strong value.
Expand Down
11 changes: 8 additions & 3 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,24 @@ <h2>Environment Variables<a class="headerlink" href="#environment-variables" tit
<div><p><em>By default, <code class="docutils literal notranslate"><span class="pre">PyNinja</span></code> will look for a <code class="docutils literal notranslate"><span class="pre">.env</span></code> file in the current working directory.</em></p>
</div></blockquote>
</details><ul class="simple">
<li><p><strong>APIKEY</strong> - API Key for authentication.</p></li>
<li><p><strong>NINJA_HOST</strong> - Hostname for the API server.</p></li>
<li><p><strong>NINJA_PORT</strong> - Port number for the API server.</p></li>
<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>MAX_CONNECTIONS</strong> - Maximum number of monitoring sessions allowed in parallel.</p></li>
<li><p><strong>SERVICE_MANAGER</strong> - Service manager filepath to handle the service status requests.</p></li>
<li><p><strong>PROCESSES</strong> - List of process names to include in the monitor page.</p></li>
<li><p><strong>SERVICES</strong> - List of service names to include in the monitor page.</p></li>
<li><p><strong>GPU_LIB</strong> - GPU library filepath to use for monitoring.</p></li>
<li><p><strong>DISK_LIB</strong> - Disk library filepath to use for monitoring.</p></li>
<li><p><strong>SERVICE_LIB</strong> - Memory library filepath to use for monitoring.</p></li>
<li><p><strong>PROCESSOR_LIB</strong> - Processor library filepath to use for monitoring.</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>
<li><p><strong>LOG_CONFIG</strong> - Logging configuration file path.</p></li>
</ul>
<p>⚠️ Enabling remote execution can be extremely risky and a major security threat.
So use <strong>caution</strong> and set the <strong>API_SECRET</strong> to a strong value.</p>
Expand Down
11 changes: 8 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,24 @@ pyninja start
> _By default, `PyNinja` will look for a `.env` file in the current working directory._
</details>
- **APIKEY** - API Key for authentication.
- **NINJA_HOST** - Hostname for the API server.
- **NINJA_PORT** - Port number for the API server.
- **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.
- **MAX_CONNECTIONS** - Maximum number of monitoring sessions allowed in parallel.
- **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
- **PROCESSES** - List of process names to include in the monitor page.
- **SERVICES** - List of service names to include in the monitor page.
- **GPU_LIB** - GPU library filepath to use for monitoring.
- **DISK_LIB** - Disk library filepath to use for monitoring.
- **SERVICE_LIB** - Memory library filepath to use for monitoring.
- **PROCESSOR_LIB** - Processor library filepath to use for monitoring.
- **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.
- **LOG_CONFIG** - Logging configuration file path.

⚠️ Enabling remote execution can be extremely risky and a major security threat.
So use **caution** and set the **API_SECRET** to a strong value.
Expand Down
11 changes: 8 additions & 3 deletions docs/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,24 @@ pyninja start
> _By default, `PyNinja` will look for a `.env` file in the current working directory._
</details>

- **APIKEY** - API Key for authentication.
- **NINJA_HOST** - Hostname for the API server.
- **NINJA_PORT** - Port number for the API server.
- **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.
- **MAX_CONNECTIONS** - Maximum number of monitoring sessions allowed in parallel.
- **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
- **PROCESSES** - List of process names to include in the monitor page.
- **SERVICES** - List of service names to include in the monitor page.
- **GPU_LIB** - GPU library filepath to use for monitoring.
- **DISK_LIB** - Disk library filepath to use for monitoring.
- **SERVICE_LIB** - Memory library filepath to use for monitoring.
- **PROCESSOR_LIB** - Processor library filepath to use for monitoring.
- **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.
- **LOG_CONFIG** - Logging configuration file path.

⚠️ Enabling remote execution can be extremely risky and a major security threat.
So use **caution** and set the **API_SECRET** to a strong value.
Expand Down
Loading

0 comments on commit dfaa0e1

Please sign in to comment.