Skip to content

Commit 29e18cb

Browse files
committed
docs: update README and CHANGELOG for v0.2.11
- README: full configuration reference with all 30+ options, grouped into General/network, Domain/appearance, Security, Features, Backup, and SMTP sections — each with defaults and descriptions - CHANGELOG: add 0.2.11 entry documenting all 15 new options - Version bump to 0.2.11
1 parent 2eb3517 commit 29e18cb

3 files changed

Lines changed: 85 additions & 32 deletions

File tree

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
11
# Changelog
22

3+
## \[0.2.11\] - 2026-05-01
4+
5+
### Added
6+
7+
- **15 new configuration options** — all configurable directly from the HA add-on Configuration tab:
8+
- `site_style` — login page style (1 = classic, 2 = modern)
9+
- `welcome_text` — custom text shown on the login screen
10+
- `new_accounts_pass` — optional password required to create a new account
11+
- `guest_device_sharing` — enable/disable guest sharing links for desktop sessions
12+
- `auto_remove_inactive_devices` — automatically remove devices offline for N days (0 = disabled)
13+
- `no_2fa` — disable two-factor authentication requirement
14+
- `max_invalid_login_count` — max failed login attempts before IP is blocked (default: 10)
15+
- `max_invalid_login_time` — time window in minutes for counting failed attempts (default: 10)
16+
- `allow_high_quality_desktop` — cap remote desktop image quality to reduce bandwidth
17+
- `allow_framing` — allow embedding MeshCentral in an iframe
18+
- `agent_port` — optional dedicated HTTPS port for agent connections only
19+
- `backup_interval_hours` — how often automatic backups run (default: 24h)
20+
- `backup_keep_days` — how many days of backups to retain (default: 10)
21+
- `backup_zip_password` — optional encryption password for backup ZIP files
22+
- `compression` default changed to `true` — GZIP enabled out of the box
23+
24+
### Documentation
25+
26+
- README configuration section fully rewritten with all options, grouped into: General/network, Domain/appearance, Security, Features, Backup, Email (SMTP)
27+
- Added descriptions and defaults for every option
28+
29+
---
30+
31+
332
## \[0.2.7\] - 2026-04-28
433

534
### Added

README.md

Lines changed: 55 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -95,75 +95,96 @@ Settings for the integration:
9595
9696
## Configuration
9797

98-
All settings are in the add-on **Configuration** tab. No JSON files to edit. The add-on generates MeshCentral's config on every start from these options.
98+
All settings are in the add-on **Configuration** tab. No JSON files to edit. The add-on generates MeshCentral's `config.json` on every start from these options.
9999

100-
### General
100+
### General / network
101101

102102
| Option | Default | Description |
103103
|--------|---------|-------------|
104104
| `server_mode` | `lan` | `lan` = local network only, `wan` = internet (requires `cert_url`), `hybrid` = both |
105-
| `cert_url` | *(empty)* | Your full external URL. Required for agents outside your local network |
106-
| `hostname` | *(HA hostname)* | Public hostname override. Leave empty to use the HA system hostname |
105+
| `cert_url` | *(empty)* | Your full external URL. Required for agents connecting from outside your local network |
106+
| `agent_port` | `0` | Optional dedicated HTTPS port for agent connections only. `0` = disabled, agents use the main port |
107+
| `mps_port` | `4433` | Port for Intel AMT Client Initiated Remote Access (CIRA) connections |
108+
| `web_rtc` | `false` | Enable WebRTC for direct peer-to-peer connections between agent and browser — reduces server relay load |
109+
| `compression` | `true` | Enable GZIP compression for web requests |
107110

108111
### Domain / appearance
109112

110113
| Option | Default | Description |
111114
|--------|---------|-------------|
112-
| `domain_title` | `MeshCentral` | Title shown on the login page |
113-
| `domain_title2` | *(empty)* | Optional subtitle |
114-
| `new_accounts` | `true` | Allow users to self-register. **Disable after creating your admin account** |
115+
| `domain_title` | `MeshCentral` | Title shown on all pages |
116+
| `domain_title2` | *(empty)* | Optional subtitle shown in the top right corner |
117+
| `site_style` | `2` | Login page style — `1` = classic, `2` = modern (default) |
118+
| `welcome_text` | *(empty)* | Custom text shown on the login screen |
119+
| `new_accounts` | `true` | Allow users to self-register from the login page. **Disable after creating your admin account** |
120+
| `new_accounts_pass` | *(empty)* | If set, users must enter this password to create a new account |
121+
| `guest_device_sharing` | `true` | Allow users to create guest sharing links for desktop and terminal sessions |
122+
| `auto_remove_inactive_devices` | `0` | Automatically remove devices that have been offline for this many days. `0` = disabled |
115123

116124
### Security
117125

118126
| Option | Default | Description |
119127
|--------|---------|-------------|
120-
| `session_key` | *(auto)* | Secret key for session cookies. Leave empty to auto-generate |
121-
| `session_time` | `60` | Session duration in minutes |
122-
| `tls_offload` | `false` | Set to `true` only if a reverse proxy handles HTTPS in front of MeshCentral |
123-
| `trusted_proxy` | *(empty)* | IPs allowed to send X-Forwarded-For headers. Use `CloudFlare` for automatic CloudFlare IP list |
124-
| `user_allowed_ip` | *(empty)* | Comma-separated IPs/ranges allowed to log in — e.g. `192.168.1.0/24`. Empty = all allowed |
125-
| `user_blocked_ip` | *(empty)* | Block these IPs from logging in |
126-
| `agent_allowed_ip` | *(empty)* | Only accept agents from these IPs |
127-
| `agent_blocked_ip` | *(empty)* | Reject agents from these IPs |
128+
| `session_key` | *(auto)* | Secret key for session cookies. Leave empty to auto-generate a new key on every start |
129+
| `session_time` | `60` | Session duration in minutes before the user must re-authenticate |
130+
| `no_2fa` | `false` | Disable two-factor authentication (2FA) for all users. Not recommended for internet-facing servers |
131+
| `max_invalid_login_count` | `10` | Maximum number of failed login attempts from an IP before it is temporarily blocked |
132+
| `max_invalid_login_time` | `10` | Time window in minutes for counting failed login attempts |
133+
| `tls_offload` | `false` | Set to `true` only if a reverse proxy handles TLS in front of MeshCentral |
134+
| `trusted_proxy` | *(empty)* | IP addresses allowed to send `X-Forwarded-For` headers. Use `CloudFlare` to auto-import Cloudflare IP ranges |
135+
| `allow_framing` | `false` | Allow the MeshCentral web UI to be embedded in an iframe on another website |
136+
| `user_allowed_ip` | *(empty)* | Only allow user logins from these IPs/ranges, e.g. `192.168.1.0/24`. Empty = all allowed |
137+
| `user_blocked_ip` | *(empty)* | Block user logins from these IPs/ranges |
138+
| `agent_allowed_ip` | *(empty)* | Only accept agent connections from these IPs/ranges |
139+
| `agent_blocked_ip` | *(empty)* | Reject agent connections from these IPs/ranges |
128140

129141
### Features
130142

131143
| Option | Default | Description |
132144
|--------|---------|-------------|
133-
| `web_rtc` | `false` | Enable WebRTC for direct peer-to-peer connections (reduces server load for desktop sessions) |
134-
| `compression` | `false` | Enable GZIP compression |
135-
| `self_update` | `false` | Let MeshCentral update itself automatically |
136-
| `maintenance_mode` | `false` | Only administrators can log in |
145+
| `allow_high_quality_desktop` | `true` | Allow users to set remote desktop quality above 60%. Set to `false` to cap quality and reduce bandwidth |
146+
| `self_update` | `false` | Let MeshCentral automatically update itself after midnight |
147+
| `maintenance_mode` | `false` | When enabled, only administrators can log in |
148+
149+
### Backup
150+
151+
Backups are stored at `/data/meshcentral-backups` and are included in Home Assistant's standard backup.
152+
153+
| Option | Default | Description |
154+
|--------|---------|-------------|
155+
| `backup_interval_hours` | `24` | How often automatic backups run, in hours |
156+
| `backup_keep_days` | `10` | How many days of backups to keep before older ones are deleted |
157+
| `backup_zip_password` | *(empty)* | Optional password to encrypt backup ZIP archives |
137158

138159
### Email (SMTP)
139160

140-
Only needed for account confirmation and password reset emails.
161+
Only needed if you want account confirmation, password reset, and notification emails.
141162

142163
| Option | Default | Description |
143164
|--------|---------|-------------|
144-
| `smtp_enabled` | `false` | Enable SMTP |
165+
| `smtp_enabled` | `false` | Enable SMTP email sending |
145166
| `smtp_host` | *(empty)* | SMTP server hostname — e.g. `smtp.gmail.com` |
146-
| `smtp_port` | `587` | Use `587` for STARTTLS or `465` for SSL |
147-
| `smtp_from` | *(empty)* | Sender address |
148-
| `smtp_user` | *(empty)* | SMTP username |
149-
| `smtp_pass` | *(empty)* | SMTP password |
150-
| `smtp_tls` | `true` | Enable TLS |
167+
| `smtp_port` | `587` | SMTP port — `587` for STARTTLS, `465` for SSL |
168+
| `smtp_from` | *(empty)* | Sender address shown in outgoing emails |
169+
| `smtp_user` | *(empty)* | SMTP login username |
170+
| `smtp_pass` | *(empty)* | SMTP login password |
171+
| `smtp_tls` | `true` | Enable TLS for the SMTP connection |
151172

152173
## Data storage
153174

154-
All data is stored under `/data/meshcentral-data` and `/data/meshcentral-backups`, both included in HA's standard backup automatically.
175+
All data is stored under `/data` and included in HA's standard backup automatically.
155176

156177
| Folder | Contents |
157178
|--------|----------|
158-
| `/data/meshcentral-data/` | Database and config |
159-
| `/data/meshcentral-data/meshcentral-files/` | Device files |
160-
| `/data/meshcentral-backups/` | Automatic backups |
179+
| `/data/meshcentral-data/` | Database and certificates |
180+
| `/data/meshcentral-data/meshcentral-files/` | Files shared via MeshCentral |
181+
| `/data/meshcentral-backups/` | Automatic server backups |
161182
| `/data/meshcentral-data/meshcentral-recordings/` | Session recordings |
162183

163184
## Troubleshooting
164185

165186
**Browser shows "ERR_EMPTY_RESPONSE" or similar:**
166-
Use `http://homeassistant.local:4431` (HTTP port) which redirects to HTTPS, or go directly to `https://homeassistant.local:4430` and accept the certificate warning.
187+
Use `http://homeassistant.local:4431` (HTTP port), which redirects to HTTPS automatically. Or go directly to `https://homeassistant.local:4430` and accept the certificate warning.
167188

168189
**Agents can't connect from outside my network:**
169190
Set `server_mode` to `wan` or `hybrid` and set `cert_url` to your external URL.
@@ -174,6 +195,9 @@ Set `new_accounts` to `true` in the Configuration tab and restart. Create your a
174195
**Settings not taking effect:**
175196
The add-on regenerates its config on every start. Restart the add-on after any configuration change.
176197

198+
**Certificate warning in browser:**
199+
This is expected — MeshCentral generates a self-signed certificate. Click **Advanced → Proceed** to continue. The connection is still encrypted.
200+
177201
## Related
178202

179203
- [MeshCentral HA Integration](https://github.com/andlo/ha-meshcentral) — HACS integration for HA entities

meshcentral/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "MeshCentral",
3-
"version": "0.2.10",
3+
"version": "0.2.11",
44
"slug": "meshcentral",
55
"description": "Self-hosted remote device management — monitor and control your PCs from Home Assistant",
66
"url": "https://github.com/andlo/ha-meshcentral-addon",

0 commit comments

Comments
 (0)