aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--man/coredns-geoip.7118
-rw-r--r--man/coredns-header.784
2 files changed, 202 insertions, 0 deletions
diff --git a/man/coredns-geoip.7 b/man/coredns-geoip.7
new file mode 100644
index 000000000..8f1896cf6
--- /dev/null
+++ b/man/coredns-geoip.7
@@ -0,0 +1,118 @@
+.\" Generated by Mmark Markdown Processer - mmark.miek.nl
+.TH "COREDNS-GEOIP" 7 "July 2021" "CoreDNS" "CoreDNS Plugins"
+
+.SH "NAME"
+.PP
+\fIgeoip\fP - Lookup maxmind geoip2 databases using the client IP, then add associated geoip data to the context request.
+
+.SH "DESCRIPTION"
+.PP
+The \fIgeoip\fP plugin add geo location data associated with the client IP, it allows you to configure a geoIP2 maxmind database
+\[la]https://dev.maxmind.com/geoip/docs/databases\[ra] to add the geo location data associated with the IP address.
+
+.PP
+The data is added leveraging the \fImetadata\fP plugin, values can then be retrieved using it as well, for example:
+
+.PP
+.RS
+
+.nf
+import (
+ "strconv"
+ "github.com/coredns/coredns/plugin/metadata"
+)
+// ...
+if getLongitude := metadata.ValueFunc(ctx, "geoip/longitude"); getLongitude != nil {
+ if longitude, err := strconv.ParseFloat(getLongitude(), 64); err == nil {
+ // Do something useful with longitude.
+ }
+} else {
+ // The metadata label geoip/longitude for some reason, was not set.
+}
+// ...
+
+.fi
+.RE
+
+.SH "DATABASES"
+.PP
+The supported databases use city schema such as \fB\fCCity\fR and \fB\fCEnterprise\fR. Other databases types with different schemas are not supported yet.
+
+.PP
+You can download a free and public City database
+\[la]https://dev.maxmind.com/geoip/geolite2-free-geolocation-data\[ra].
+
+.SH "SYNTAX"
+.PP
+.RS
+
+.nf
+geoip [DBFILE]
+
+.fi
+.RE
+
+.IP \(bu 4
+\fBDBFILE\fP the mmdb database file path.
+
+
+.SH "EXAMPLES"
+.PP
+The following configuration configures the \fB\fCCity\fR database.
+
+.PP
+.RS
+
+.nf
+\&. {
+ geoip /opt/geoip2/db/GeoLite2\-City.mmdb
+ metadata # Note that metadata plugin must be enabled as well.
+}
+
+.fi
+.RE
+
+.SH "METADATADA LABELS"
+.PP
+A limited set of fields will be exported as labels, all values are stored using strings \fBregardless of their underlying value type\fP, and therefore you may have to convert it back to its original type, note that numeric values are always represented in base 10.
+
+.RS
+.TS
+allbox;
+l l l l
+l l l l .
+\fBLabel\fP\fB Type\fP\fB Example\fP\fB Description\fP
+\fB\fCgeoip/city/name\fR \fB\fCstring\fR \fB\fCCambridge\fR Then city name in English language.
+\fB\fCgeoip/country/code\fR \fB\fCstring\fR \fB\fCGB\fR Country ISO 3166-1
+\[la]https://en.wikipedia.org/wiki/ISO_3166-1\[ra] code.
+\fB\fCgeoip/country/name\fR \fB\fCstring\fR \fB\fCUnited Kingdom\fR The country name in English language.
+\fB\fCgeoip/country/is_in_european_union\fR \fB\fCbool\fR \fB\fCfalse\fR Either \fB\fCtrue\fR or \fB\fCfalse\fR.
+\fB\fCgeoip/continent/code\fR \fB\fCstring\fR \fB\fCEU\fR See Continent codes
+\[la]#ContinentCodes\[ra].
+\fB\fCgeoip/continent/name\fR \fB\fCstring\fR \fB\fCEurope\fR The continent name in English language.
+\fB\fCgeoip/latitude\fR \fB\fCfloat64\fR \fB\fC52.2242\fR Base 10, max available precision.
+\fB\fCgeoip/longitude\fR \fB\fCfloat64\fR \fB\fC0.1315\fR Base 10, max available precision.
+\fB\fCgeoip/timezone\fR \fB\fCstring\fR \fB\fCEurope/London\fR The timezone.
+\fB\fCgeoip/postalcode\fR \fB\fCstring\fR \fB\fCCB4\fR The postal code.
+.TE
+.RE
+
+
+.SH "CONTINENT CODES"
+.RS
+.TS
+allbox;
+l l
+l l .
+\fBValue\fP\fB Continent (EN)\fP
+AF Africa
+AN Antarctica
+AS Asia
+EU Europe
+NA North America
+OC Oceania
+SA South America
+.TE
+.RE
+
+
diff --git a/man/coredns-header.7 b/man/coredns-header.7
new file mode 100644
index 000000000..c0e76e46d
--- /dev/null
+++ b/man/coredns-header.7
@@ -0,0 +1,84 @@
+.\" Generated by Mmark Markdown Processer - mmark.miek.nl
+.TH "COREDNS-HEADER" 7 "July 2021" "CoreDNS" "CoreDNS Plugins"
+
+.SH "NAME"
+.PP
+\fIheader\fP - modifies the header for responses.
+
+.SH "DESCRIPTION"
+.PP
+\fIheader\fP ensures that the flags are in the desired state for responses. The modifications are made transparently for
+the client.
+
+.SH "SYNTAX"
+.PP
+.RS
+
+.nf
+header {
+ ACTION FLAGS...
+ ACTION FLAGS...
+}
+
+.fi
+.RE
+
+.IP \(bu 4
+\fBACTION\fP defines the state for DNS message header flags. Actions are evaluated in the order they are defined so last one has the
+most precedence. Allowed values are:
+
+.RS
+.IP \(en 4
+\fB\fCset\fR
+.IP \(en 4
+\fB\fCclear\fR
+
+.RE
+.IP \(bu 4
+\fBFLAGS\fP are the DNS header flags that will be modified. Current supported flags include:
+
+.RS
+.IP \(en 4
+\fB\fCaa\fR - Authoritative(Answer)
+.IP \(en 4
+\fB\fCra\fR - RecursionAvailable
+.IP \(en 4
+\fB\fCrd\fR - RecursionDesired
+
+.RE
+
+
+.SH "EXAMPLES"
+.PP
+Make sure recursive available \fB\fCra\fR flag is set in all the responses:
+
+.PP
+.RS
+
+.nf
+\&. {
+ header {
+ set ra
+ }
+}
+
+.fi
+.RE
+
+.PP
+Make sure "recursion available" \fB\fCra\fR and "authoritative answer" \fB\fCaa\fR flags are set and "recursion desired" is cleared in all responses:
+
+.PP
+.RS
+
+.nf
+\&. {
+ header {
+ set ra aa
+ clear rd
+ }
+}
+
+.fi
+.RE
+
dn-link'>remote-cdn-link Unnamed repository; edit this file 'description' to name the repository.
aboutsummaryrefslogtreecommitdiff
path: root/examples/docs/README.md (unfollow)
AgeCommit message (Expand)AuthorFilesLines
2022-02-28update ci branch nameGravatar Fred K. Schott 1-0/+2
2022-02-28Make smoke tests more deterministic (#2618)Gravatar Fred K. Schott 336-147/+34315
2022-02-28[ci] yarn formatGravatar natemoo-re 1-20/+20
2022-02-28[ci] release (#2683)astro@0.23.3Gravatar github-actions[bot] 31-54/+55
2022-02-28Fix typo (#2674)Gravatar Robin Millette 1-1/+1
2022-02-28[ci] update lockfile (#2676)Gravatar Fred K. Schott 1-6/+6
2022-02-28fix(runtime): do not render empty Fragment (#2667)Gravatar Mateus Esdras 1-0/+3
2022-02-28fix(hmr): HMR regression related to .astro updates (#2681)Gravatar Nate Moore 6-7/+24
2022-02-28Fix HTMLElement expression warning (#2675)Gravatar Jonathan Neal 1-1/+1
2022-02-28[ci] collect statsGravatar FredKSchott 1-0/+1
2022-02-27[ci] update lockfile (#2668)Gravatar Fred K. Schott 1-80/+80
2022-02-27[ci] collect statsGravatar FredKSchott 1-0/+1
2022-02-26[ci] collect statsGravatar FredKSchott 1-0/+1
2022-02-25[ci] yarn formatGravatar natemoo-re 1-20/+20
2022-02-25[ci] release (#2666)astro@0.23.2Gravatar github-actions[bot] 32-59/+57
2022-02-25[ci] yarn formatGravatar natemoo-re 2-12/+6
2022-02-25fix astro scoping of "@import" inside of style tags (#2656)Gravatar Fred K. Schott 3-6/+35
2022-02-25[ci] update lockfile (#2659)Gravatar Fred K. Schott 1-20/+20
2022-02-25feat: improve third-party Astro package compatability (#2665)Gravatar Nate Moore 3-6/+100
2022-02-25get new example working during buildGravatar Fred K. Schott 4-16/+21
2022-02-25[ci] yarn formatGravatar FredKSchott 1-7/+6
2022-02-25Add Non-HTML Pages example (#2637)Gravatar Joel Kuzmarski 11-0/+136
2022-02-25[ci] collect statsGravatar FredKSchott 1-0/+1
2022-02-24[ci] yarn formatGravatar natemoo-re 2-24/+24
2022-02-24[ci] release (#2641)astro@0.23.1@astrojs/markdown-remark@0.6.2Gravatar github-actions[bot] 38-90/+81
2022-02-24ensure utf8 encoding when serving html (#2654)Gravatar Fred K. Schott 3-4/+9
2022-02-24fix(core): Issue #2625. error with process.env.LANG larger than 5 (#2645)Gravatar Javier Cortés 2-1/+6
2022-02-24[ci] update lockfile (#2646)Gravatar Fred K. Schott 1-130/+124
2022-02-24chore: upgrade compiler (#2653)Gravatar Nate Moore 3-11/+11
2022-02-24[ci] yarn formatGravatar natemoo-re 2-5/+5
2022-02-24Add fine-grained HMR support (#2649)Gravatar Nate Moore 7-36/+37
2022-02-24[ci] collect statsGravatar FredKSchott 1-0/+1
2022-02-23Fixed incorrect types and imports (#2630)Gravatar Juan Martín Seery 27-35/+37
2022-02-23Add sass dev dep to blog-multiple-authors example (#2643)Gravatar Joel Kuzmarski 1-1/+2
2022-02-23Fix(component): align starting position in Markdown slot (#2631)Gravatar Shinobu Hayashi 4-6/+61
2022-02-23[ci] yarn formatGravatar matthewp 1-1/+1
2022-02-23Run all smoke tests with the static build (#2609)Gravatar Matthew Phillips 2-26/+32
2022-02-23[ci] collect statsGravatar FredKSchott 1-0/+1
2022-02-22[ci] update lockfile (#2624)Gravatar Fred K. Schott 1-171/+201
2022-02-22Fixed shiki import to work with "type": "module" (#2628)Gravatar Juan Martín Seery 3-5/+13