Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ All service components follow this architecture:
- Use the `service.js` mixin (`src/mixins/service.js`) for common API functionality
- Use a custom `fetch` method provided by the service mixin to seamlessly support proxy configuration, custom headers, and credentials.

### Auto-Update Configuration

Services support automatic data refreshing using a centralized scheduler system with global and per-service configuration:

#### Global Configuration

`autoUpdate: 30000` - Set default interval for all services (30 seconds)

#### Service Configuration
- **Service-specific interval**: `updateInterval: 10000` - Override global default
- **Disable per service**: `autoUpdateInterval: false` - Disable for specific service
- **Use global default**: Omit `autoUpdateInterval` to use global setting

### Configuration & Routing

- **Multi-page Support**: Hash-based routing without Vue Router
Expand Down
7 changes: 5 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ links:
icon: "fas fa-file-alt"
url: "#page2"

# Optional: enable periodic refresh for all smart cards that implements it (unless overriden at service configuration level).
updateIntervalMs: 30000 # interval in milliseconds, minimum is 1000 (1s). Remove or set to 0 to disable. Can be overriden at service level. (default disabled)

# Services
# First level array represents a group.
# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
Expand Down Expand Up @@ -183,9 +186,9 @@ Empty values (either in `config.yml` or the endpoint data) will hide the element
## Connectivity checks

As a webapp (PWA) the dashboard can still be displayed when your homer server is offline.
The connectivity checker periodically sends a HEAD request bypassing the PWA cache to the dashbord page to make sure it's still reachable.
The connectivity checker periodically sends a HEAD request bypassing the PWA cache to the dashboard page to make sure it's still reachable.

It can be useful when you access your dashboard through a VPN or ssh tunnel for example, to know if your conection is up. It also helps when using an authentication proxy, it will reload the page if the authentication expires (when a redirect is send in response to the HEAD request).
It can be useful when you access your dashboard through a VPN or ssh tunnel for example, to know if your connection is up. It also helps when using an authentication proxy, it will reload the page if the authentication expires (when a redirect is send in response to the HEAD request).

## Style Options

Expand Down
Loading
Loading