rgaudin
commented
1 year ago User Inputs:
| Input | Validator | Usage | OK? |
|---|---|---|---|
| Hotspot Name | is_valid_ssid, is_valid_hostname, is_valid_domain |
SSID, hostname, domain (without tld) | ✅ |
| Config Name | - | Cardshop listing | ✅ |
| Language | pibox.is_valid_language |
Homepage language1 | ❌ |
| Timezone | is_valid_timezone |
Pi's timezone | ✅ |
| WiFi Password | is_valid_wpa2_passphrase |
AP WPA2 Passphrase | ✅ ⚠️2 |
| Admin Account | pibox.is_valid_admin_login |
EduPi admin, (clock access) | ⚠️3 |
| Admin Password | pibox.is_valid_admin_password |
EduPi Admin, WikiFundi Admin, (clock access) | ⚠️3 |
| Branding Logo | Manager: <1MiB image converted to PNG | Homepage and Captive portal | ✅ ⚠️4 |
| Branding Favicon | Manager: <1MiB image converted to PNG | Homepage, Captive portal, Clock | ✅ ⚠️4 |
| Branding CSS | - | TBD (was applied to homepage and errors) | ⚠️3 |
- 1: Our homepage included localized title and description for the few static content we offered (English, French). This is valuable. It's not config nor runtime specific but app-specific so its supported list should be stored elsewhere and we should provide a
MAIN_LANGUAGEenv to all our containers. Can be used as fallback for captive-portal, home, clock, etc - 2: Some correct (offspot-config) checks are more permissive (longer wifi password for instance) than they used to be. It means once merged we could create config with valid input that could fail at creation time in kiwix-hotspotv1. Will vanish as soon as we switch to image-creator. Can add glue to hotspot-behavior if we see user-cards failing.
- 3: Those passwords are app-specific and not config/runtime. Very valuable to only require a single set of credentials (actually we could drop the login) but we need to store requirements for each app elsewhere and validate that all matches.
- 4: We currently have no size restrictions on this. Given how raw the homepage/captive-portal is, I think we should wait for a UI refresh (@siemsie) to define/enforce those
Offspot-config validators currently uses kiwix-hotspot ones. Should be replaced by runtime-config ones