Skip to content

Commit

Permalink
Update all sample variables
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed Jan 7, 2025
1 parent 6177ad2 commit 8d7c528
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 22 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ So use **caution** and set the **API_SECRET** to a strong value.
- **DISK_LIB** - Library path to retrieve disk info using [PyArchitecture].
- **PROCESSOR_LIB** - Library path to retrieve processor name using [PyArchitecture].

> Certain environment variables like `SERVICES` and `PROCESSS` are case-sensitive
> Refer [samples] directory for examples.
## Coding Standards
Expand Down
3 changes: 3 additions & 0 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ <h2>Environment Variables<a class="headerlink" href="#environment-variables" tit
<li><p><strong>PROCESSOR_LIB</strong> - Library path to retrieve processor name using <a class="reference external" href="https://github.com/thevickypedia/PyArchitecture">PyArchitecture</a>.</p></li>
</ul>
<blockquote>
<div><p>Certain environment variables like <code class="docutils literal notranslate"><span class="pre">SERVICES</span></code> and <code class="docutils literal notranslate"><span class="pre">PROCESSS</span></code> are case-sensitive</p>
</div></blockquote>
<blockquote>
<div><p>Refer <a class="reference external" href="https://github.com/thevickypedia/PyNinja/tree/main/samples">samples</a> directory for examples.</p>
</div></blockquote>
</section>
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ So use **caution** and set the **API_SECRET** to a strong value.
- **DISK_LIB** - Library path to retrieve disk info using [PyArchitecture].
- **PROCESSOR_LIB** - Library path to retrieve processor name using [PyArchitecture].

> Certain environment variables like `SERVICES` and `PROCESSS` are case-sensitive
> Refer [samples] directory for examples.
## Coding Standards
Expand Down
2 changes: 2 additions & 0 deletions docs/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ So use **caution** and set the **API_SECRET** to a strong value.
- **DISK_LIB** - Library path to retrieve disk info using [PyArchitecture].
- **PROCESSOR_LIB** - Library path to retrieve processor name using [PyArchitecture].

> Certain environment variables like `SERVICES` and `PROCESSS` are case-sensitive

> Refer [samples] directory for examples.

## Coding Standards
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

16 changes: 11 additions & 5 deletions samples/.env
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
APIKEY="S3cret@ccessToken"
SWAGGER_UI_PARAMETERS='{"deepLinking": true, "persistAuthorization": true, "displayRequestDuration": true, "docExpansion": "full"}'
NINJA_HOST="0.0.0.0"
NINJA_PORT=8005
WORKERS=3
RATE_LIMIT='[{"max_requests": 3, "seconds": 1}, {"max_requests": 10, "seconds": 3}]'
LOG_CONFIG="log_config.yml"
REMOTE_EXECUTION=True
API_SECRET="3A%3/[&1X>ARsz{hADFYI'}XhK4H)Gi~"
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"
DISK_REPORT=True
MAX_CONNECTIONS=10
NO_AUTH=False
PROCESSES='["Python", "Brave", "Ollama"]'
SERVICES='["Telegram", "pyfilebrowser"]'
34 changes: 26 additions & 8 deletions samples/secrets.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"APIKEY": "S3cret@ccessToken",
"SWAGGER_UI_PARAMETERS": {
"deepLinking": true,
"persistAuthorization": true,
"displayRequestDuration": true,
"docExpansion": "full"
},
"NINJA_HOST": "0.0.0.0",
"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,
Expand All @@ -18,5 +18,23 @@
"seconds": 3
}
],
"APIKEY": "S3cret@ccessToken"
"LOG_CONFIG": "log_config.yml",
"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,
"DISK_REPORT": true,
"MAX_CONNECTIONS": 10,
"NO_AUTH": false,
"PROCESSES": [
"Python",
"Brave",
"Ollama"
],
"SERVICES": [
"Telegram",
"pyfilebrowser"
]
}
31 changes: 23 additions & 8 deletions samples/secrets.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
NINJA_HOST: 0.0.0.0
NINJA_PORT: 8005
WORKERS: 3
REMOTE_EXECUTION: true
API_SECRET: "3A%3/[&1X>ARsz{hADFYI'}XhK4H)Gi~"
MONITOR_USERNAME: username
APIKEY: S3cret@ccessToken
API_SECRET: 3A%3/[&1X>ARsz{hADFYI'}XhK4H)Gi~
DATABASE: auth_errors.db
DISK_REPORT: true
LOG_CONFIG: log_config.yml
MAX_CONNECTIONS: 10
MONITOR_PASSWORD: password
MONITOR_SESSION: 3600
DATABASE: auth_errors.db
MONITOR_USERNAME: username
NINJA_HOST: 0.0.0.0
NINJA_PORT: 8005
NO_AUTH: false
PROCESSES:
- Python
- Brave
- Ollama
RATE_LIMIT:
- max_requests: 3
seconds: 1
- max_requests: 10
seconds: 3
APIKEY: S3cret@ccessToken
REMOTE_EXECUTION: true
SERVICES:
- Telegram
- pyfilebrowser
SWAGGER_UI_PARAMETERS:
deepLinking: true
displayRequestDuration: true
docExpansion: full
persistAuthorization: true

0 comments on commit 8d7c528

Please sign in to comment.