Skip to content

Commit 346873f

Browse files
okraitsokraits
committed
Add ip_* properties and descriptions for all ddns properties
1 parent ca79cc3 commit 346873f

File tree

1 file changed

+58
-3
lines changed

1 file changed

+58
-3
lines changed

‎netjsonconfig/backends/openwrt/schema.py

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -464,37 +464,46 @@
464464
"upd_privateip": {
465465
"type": "boolean",
466466
"title": "upd_privateip",
467+
"description": "disallow/allow sending of private/special IP's to the DDNS provider; "
468+
"blocked IPv4: 0/8, 10/8, 100.64/10, 127/8, 169.254/16, 172.16/12, "
469+
"192.168/16; blocked IPv6: ::/32, f000::/4",
467470
"default": False,
468471
"format": "checkbox",
469472
"propertyOrder": 1,
470473
},
471474
"ddns_dateformat": {
472475
"type": "string",
473476
"title": "ddns_dateformat",
477+
"description": "date format to use for displaying dates in logfiles and LuCI",
474478
"default": "%F %R",
475479
"propertyOrder": 2,
476480
},
477481
"ddns_rundir": {
478482
"type": "string",
479483
"title": "ddns_rundir",
484+
"description": "directory to use for *.pid and *.update files",
480485
"default": "/var/run/ddns",
481486
"propertyOrder": 3,
482487
},
483488
"ddns_logdir": {
484489
"type": "string",
485490
"title": "ddns_logdir",
491+
"description": "directory to use for *.log files",
486492
"default": "/var/log/ddns",
487493
"propertyOrder": 4,
488494
},
489495
"ddns_loglines": {
490496
"type": "integer",
491497
"title": "ddns_loglines",
498+
"description": "number of lines stored in *.log files before automatically truncated",
492499
"default": 250,
493500
"propertyOrder": 5,
494501
},
495502
"use_curl": {
496503
"type": "boolean",
497504
"title": "use_curl",
505+
"description": "if both wget and curl are installed, wget is used for communication "
506+
"by default",
498507
"default": False,
499508
"format": "checkbox",
500509
"propertyOrder": 6,
@@ -529,57 +538,102 @@
529538
"interface": {
530539
"type": "string",
531540
"title": "interface",
541+
"description": "network from /etc/config/network to monitor for up/down "
542+
"events to start the ddns update script via hotplug",
532543
"propertyOrder": 2,
533544
},
534545
"ip_source": {
535546
"type": "string",
536547
"title": "ip_source",
548+
"description": "specifies the source to detect the local IP: 'network' uses "
549+
"'ip_network', 'web' uses 'ip_url', 'interface' uses "
550+
"'ip_interface', 'script' uses 'ip_script'",
551+
"enum": [
552+
"network",
553+
"web",
554+
"interface",
555+
"script"
556+
],
537557
"default": "network",
538558
"propertyOrder": 3,
539559
},
540560
"lookup_host": {
541561
"type": "string",
542562
"title": "lookup_host",
563+
"description": "FQDN of the host registered at the DDNS provider",
543564
"propertyOrder": 4,
544565
},
545566
"domain": {
546567
"type": "string",
547568
"title": "domain",
569+
"description": "the DNS name to update; this property can also be used for "
570+
"special multihost update configurations supported by"
571+
" some providers",
548572
"propertyOrder": 5,
549573
},
550574
"username": {
551575
"type": "string",
552576
"title": "username",
577+
"description": "username of the DDNS service account",
553578
"propertyOrder": 6,
554579
},
555580
"password": {
556581
"type": "string",
557582
"title": "password",
583+
"description": "password of the DDNS service account",
558584
"propertyOrder": 7,
559585
},
560586
"service_name": {
561587
"type": "string",
562588
"title": "service_name",
589+
"description": "name of the DDNS service to use",
563590
"propertyOrder": 8,
564591
},
565592
"update_url": {
566593
"type": "string",
567594
"title": "update_url",
595+
"description": "url to the DDNS service to use if 'service_name' is not set",
568596
"propertyOrder": 9,
569597
},
570598
"update_script": {
571599
"type": "string",
572600
"title": "update_script",
601+
"description": "script to use if 'service_name' is not set",
573602
"propertyOrder": 10,
574603
},
604+
"ip_network": {
605+
"type": "string",
606+
"title": "ip_network",
607+
"description": "network from /etc/config/network to use for detecting the IP "
608+
"if 'ip_source' is set to 'network'",
609+
"default": "wan",
610+
"propertyOrder": 11,
611+
},
612+
"ip_url": {
613+
"type": "string",
614+
"title": "ip_url",
615+
"description": "url to use for detecting the IP if 'ip_source' is set to "
616+
"'web'",
617+
"propertyOrder": 12,
618+
},
575619
"ip_interface": {
576620
"type": "string",
577621
"title": "ip_interface",
578-
"propertyOrder": 11,
622+
"description": "local interface to use for detecting the IP if 'ip_source' is"
623+
" set to 'interface'",
624+
"propertyOrder": 13,
625+
},
626+
"ip_script": {
627+
"type": "string",
628+
"title": "ip_script",
629+
"description": "script to use for detecting the IP if 'ip_source' is set to "
630+
"'script'",
631+
"propertyOrder": 14,
579632
},
580633
"use_syslog": {
581634
"type": "integer",
582635
"title": "use_syslog",
636+
"description": "level of events logged to syslog",
583637
"enum": [
584638
"disable",
585639
"info, notice, warning, errors",
@@ -588,13 +642,14 @@
588642
"errors"
589643
],
590644
"default": 0,
591-
"propertyOrder": 12,
645+
"propertyOrder": 15,
592646
},
593647
"use_logfile": {
594648
"type": "boolean",
595649
"title": "use_logfile",
650+
"description": "disable/enable logging to logfile",
596651
"default": True,
597-
"propertyOrder": 13,
652+
"propertyOrder": 16,
598653
}
599654
}
600655
}

0 commit comments

Comments
 (0)