mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
Anso
ffabfd1c39
Update 11 doc pages with accurate content and capture 14 fresh screenshots. Remove JWT_SECRET from configuration (auto-generated), fix editor container actions, add missing Settings sections, update Features Overview, and add remote alerts documentation.
217 lines
7.4 KiB
Plaintext
217 lines
7.4 KiB
Plaintext
---
|
|
title: Settings Reference
|
|
description: Complete reference for every option in the Sencho Settings Hub.
|
|
---
|
|
|
|
Open the Settings Hub by clicking **Settings** in the top navigation bar. The left sidebar lists all available sections.
|
|
|
|
<Frame>
|
|
<img src="/images/settings/settings-overview.png" alt="Settings Hub showing the Account tab and the full section sidebar" />
|
|
</Frame>
|
|
|
|
---
|
|
|
|
## Account
|
|
|
|
**Scope:** Global (applies to this Sencho instance, not per-node)
|
|
|
|
Change the admin account password. All three fields are required.
|
|
|
|
| Field | Description |
|
|
|-------|-------------|
|
|
| **Current Password** | Your existing password for verification |
|
|
| **New Password** | Must be at least 6 characters |
|
|
| **Confirm New Password** | Must match New Password |
|
|
|
|
Click **Update Password** to apply. The change takes effect immediately; existing sessions remain valid.
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
**Scope:** Global
|
|
|
|
Manage your Sencho Pro license from this section.
|
|
|
|
| Element | Description |
|
|
|---------|-------------|
|
|
| **Current tier** | Shows whether you are on Community or Pro, with a tier badge |
|
|
| **Trial status** | If on a trial, shows remaining days |
|
|
| **Customer / Plan / Key** | Displayed when a Pro license is active |
|
|
| **Renews** | Next renewal date for active subscriptions |
|
|
| **View Pricing** | Opens the Sencho pricing page to purchase a license |
|
|
| **Activate** | Enter a license key to activate Pro |
|
|
| **Manage Subscription** | Opens the billing portal (active Pro only) |
|
|
| **Deactivate License** | Reverts to Community features (active Pro only) |
|
|
|
|
---
|
|
|
|
## Users
|
|
|
|
<Note>
|
|
Users management requires a Sencho Pro license and admin role. Community Edition supports a single admin account only.
|
|
</Note>
|
|
|
|
**Scope:** Global
|
|
|
|
Create and manage user accounts with role-based access.
|
|
|
|
| Action | Description |
|
|
|--------|-------------|
|
|
| **Create user** | Add a new account with username, password, and role (Admin or Viewer) |
|
|
| **Edit user** | Change an existing user's password or role |
|
|
| **Delete user** | Remove a user account |
|
|
|
|
See [RBAC & User Management](/features/rbac) for details on what each role can access.
|
|
|
|
---
|
|
|
|
## System Limits
|
|
|
|
**Scope:** Per-node (applies to the currently selected node)
|
|
|
|
Configure resource thresholds that trigger visual warnings on the dashboard stat cards. These are display thresholds only - Sencho does not throttle or kill containers when limits are reached.
|
|
|
|
| Setting | Range | Description |
|
|
|---------|-------|-------------|
|
|
| **Host CPU Limit** | 1-100% | CPU percentage above which the CPU card turns orange/red |
|
|
| **Host RAM Limit** | 1-100% | RAM percentage above which the RAM card turns orange/red |
|
|
| **Host Disk Limit** | 1-100% | Disk percentage above which the Disk card turns orange/red |
|
|
| **Docker Janitor Threshold** | 0+ GB | Minimum free disk space to maintain. When free space falls below this value, a warning is shown. Set to `0` to disable. |
|
|
| **Global Crash Alerts** | On / Off | When enabled, Sencho sends a notification whenever any managed container exits unexpectedly |
|
|
|
|
Click **Save** to apply. An unsaved-changes indicator appears when you have edits pending.
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
**Scope:** Global
|
|
|
|
Configure external destinations for alert notifications. Three agent types are supported, each on its own sub-tab: **Discord**, **Slack**, and **Webhook**.
|
|
|
|
For each agent:
|
|
|
|
| Field | Description |
|
|
|-------|-------------|
|
|
| **Enable toggle** | Activates or deactivates this agent. Disabled agents receive no messages even if a URL is saved. |
|
|
| **Webhook URL** | The endpoint Sencho will POST to when an alert fires |
|
|
|
|
Click **Save** to persist changes. Click **Test** to send a test payload immediately and verify delivery.
|
|
|
|
At least one agent must be enabled for stack alerts to deliver notifications. See [Alerts & Notifications](/features/alerts-notifications) for how to create alert rules.
|
|
|
|
---
|
|
|
|
## Webhooks
|
|
|
|
<Note>
|
|
Webhooks require a Sencho Pro license.
|
|
</Note>
|
|
|
|
**Scope:** Global
|
|
|
|
Create and manage HTTP webhooks that external systems (CI/CD pipelines, automation tools) can call to trigger stack actions. See [Webhooks](/features/webhooks) for the full walkthrough including authentication and CI examples.
|
|
|
|
Quick reference:
|
|
|
|
| Action | How |
|
|
|--------|-----|
|
|
| Create a webhook | Click **Create Webhook**, select a stack and action |
|
|
| Copy trigger URL | Click the copy icon on any webhook row |
|
|
| View execution history | Expand a webhook row to see recent executions |
|
|
| Delete a webhook | Click the trash icon |
|
|
|
|
---
|
|
|
|
## Developer
|
|
|
|
**Scope:** Per-node (applies to the currently selected node)
|
|
|
|
Advanced settings for log streaming behaviour and data retention. Most users can leave these at their defaults.
|
|
|
|
| Setting | Default | Description |
|
|
|---------|---------|-------------|
|
|
| **Developer Mode** | Off | When on, the [Global Observability](/features/global-observability) view switches from polling to real-time Server-Sent Events streaming |
|
|
| **Global Logs Refresh Rate** | 5s | Polling interval in standard mode. Options: `1s`, `3s`, `5s`, `10s` |
|
|
| **Metrics Retention Hours** | 24 | How many hours of CPU/RAM history to keep for dashboard charts. Max: 8,760 (1 year) |
|
|
| **Log Retention Days** | 30 | How many days of notification history to keep in the database. Max: 365 |
|
|
|
|
Click **Save** to apply.
|
|
|
|
<Note>
|
|
Lower refresh rates (1s) increase backend CPU usage as Sencho polls Docker more frequently. Use only when actively debugging.
|
|
</Note>
|
|
|
|
---
|
|
|
|
## Nodes
|
|
|
|
**Scope:** Global
|
|
|
|
Manage connections to local and remote Sencho instances. This is the same interface as the [Multi-Node](/features/multi-node) feature - see that page for the full walkthrough.
|
|
|
|
Quick reference:
|
|
|
|
| Action | How |
|
|
|--------|-----|
|
|
| Add a remote node | Click **+ Add Node** |
|
|
| Generate a token for this instance | Click **Generate Token** |
|
|
| Test an existing node's connectivity | Click the wifi icon on any row |
|
|
| Edit a node | Click the pencil icon |
|
|
| Delete a node | Click the trash icon (remote nodes only) |
|
|
|
|
---
|
|
|
|
## App Store
|
|
|
|
**Scope:** Global
|
|
|
|
| Setting | Default | Description |
|
|
|---------|---------|-------------|
|
|
| **Template Registry URL** | LinuxServer.io registry | The URL Sencho fetches templates from. Must return a JSON array in Portainer v2 template format. Leave blank to restore the default. |
|
|
|
|
Click **Save** to update the URL. Click **Refresh Cache** to clear the cached template list and fetch fresh data from the registry immediately.
|
|
|
|
See [App Store](/features/app-store#custom-template-registry) for more on custom registries.
|
|
|
|
---
|
|
|
|
## Support
|
|
|
|
**Scope:** Global
|
|
|
|
Links to help resources available to all tiers, plus priority support channels for Pro users.
|
|
|
|
### Resources (all tiers)
|
|
|
|
| Resource | Description |
|
|
|----------|-------------|
|
|
| **Documentation** | Opens docs.sencho.io - guides, reference, and tutorials |
|
|
| **GitHub Issues** | Report bugs and request features on GitHub |
|
|
|
|
### Pro support
|
|
|
|
Pro license holders get additional support channels:
|
|
|
|
| Channel | Description |
|
|
|---------|-------------|
|
|
| **Email Support** | Direct email support (Personal Pro) |
|
|
| **Priority Email Support** | Responses within 24 hours (Team Pro) |
|
|
|
|
---
|
|
|
|
## About
|
|
|
|
**Scope:** Global
|
|
|
|
Displays instance information at a glance.
|
|
|
|
| Field | Description |
|
|
|-------|-------------|
|
|
| **Version** | Current Sencho version |
|
|
| **Tier** | Community or Pro tier badge |
|
|
| **License Status** | Active, trial, expired, or community |
|
|
| **Instance ID** | Unique identifier for this Sencho instance (shown when a license is active) |
|
|
| **Changelog** | Link to the full changelog on GitHub |
|