improve docs and set default domain_suffix to be list

netdisco · Sep 3, 2019 · 6d881de · 6d881de
1 parent 1dcafc0
commit 6d881de
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/lib/App/Netdisco/DB/ResultSet/NodeIp.pm b/lib/App/Netdisco/DB/ResultSet/NodeIp.pm
@@ -99,7 +99,11 @@ sub search_by_ip {
 
 =head1 search_by_dns( \%cond, \%attrs? )
 
- my $set = $rs->search_by_dns({dns => 'foo.example.com', active => 1});
+ my $set = $rs->search_by_dns({
+   dns => 'foo.example.com',
+   suffix => qr/(?:\.example\..com|\.local)$/,
+   active => 1
+ });
 
 Like C<search()>, this returns a ResultSet of matching rows from the
 NodeIp table.
@@ -118,8 +122,8 @@ to search for. The value may optionally include SQL wildcard characters.
 
 =item *
 
-The C<cond> parameter may optionally have a suffix parameter which is a
-regular expression of domain names that must also match the results.
+The C<cond> parameter may optionally have a C<suffix> parameter which is a
+regular expression of domain names - one of which must match the results.
 
 =item *
 

diff --git a/share/config.yml b/share/config.yml
@@ -22,7 +22,7 @@ external_databases: []
 # WEB FRONTEND
 # ------------
 
-domain_suffix: ""
+domain_suffix: []
 no_auth: false
 suggest_guest: false
 navbar_autocomplete: true

diff --git a/share/environments/deployment.yml b/share/environments/deployment.yml
@@ -36,7 +36,7 @@ device_auth:
 # will be stripped from fqdn when displayed in the web UI
 # also, do not forget the leading dot.
 # ```````````````````````````````````````````````````````
-#domain_suffix: '.example.com'
+#domain_suffix: ['.example.com']
 
 
 # ¯`·.¸¸.·´¯`·.¸¸.·´¯`·.¸¸.·´¯`·.¸¸.·´¯`·.¸¸.·´¯`·.¸¸.·´¯`·.¸¸.·´¯`·.¸¸