Browse code

modules: readme files regenerated - app_lua_sr ... [skip ci]

Kamailio Dev authored on 25/05/2020 09:21:05
Showing 1 changed files
... ...
@@ -10,8 +10,6 @@ Daniel-Constantin Mierla
10 10
 
11 11
    <miconda@gmail.com>
12 12
 
13
-Edited by
14
-
15 13
 Alex Balashov
16 14
 
17 15
    Evariste Systems LLC
Browse code

modules: readme files regenerated - acc ... [skip ci]

Kamailio Dev authored on 28/02/2018 17:03:37 • The Root committed on 28/02/2018 19:11:36
Showing 1 changed files
... ...
@@ -86,7 +86,7 @@ Chapter 1. Admin Guide
86 86
 
87 87
    Debian Linux squeeze includes already a database as dependency, but as
88 88
    this contain the wrong data, it will not work correctly with the
89
-   module. More acurate, the module expect the GeoIP City Edition, and
89
+   module. More accurate, the module expect the GeoIP City Edition, and
90 90
    will not work with the GeoIP Country Edition. In newer Debian Linux
91 91
    releases the package geoip-database-contrib should contain the
92 92
    necessary database. You can download the Lite edition of the DB from
Browse code

modules: readme files regenerated - acc ... [skip ci]

Kamailio Dev authored on 11/04/2017 13:48:48
Showing 1 changed files
... ...
@@ -165,4 +165,4 @@ if(geoip_match("$si", "src"))
165 165
           + contc - continent code
166 166
 
167 167
    Exported pseudo-variables are documented at
168
-   http://www.kamailio.org/wiki/.
168
+   https://www.kamailio.org/wiki/.
Browse code

core, lib, modules: restructured source code tree

- new folder src/ to hold the source code for main project applications
- main.c is in src/
- all core files are subfolder are in src/core/
- modules are in src/modules/
- libs are in src/lib/
- application Makefiles are in src/
- application binary is built in src/ (src/kamailio)

Daniel-Constantin Mierla authored on 07/12/2016 11:03:51
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,168 @@
1
+geoip Module
2
+
3
+Daniel-Constantin Mierla
4
+
5
+   asipto.com
6
+
7
+Edited by
8
+
9
+Daniel-Constantin Mierla
10
+
11
+   <miconda@gmail.com>
12
+
13
+Edited by
14
+
15
+Alex Balashov
16
+
17
+   Evariste Systems LLC
18
+   <abalashov@evaristesys.com>
19
+
20
+   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
21
+     __________________________________________________________________
22
+
23
+   Table of Contents
24
+
25
+   1. Admin Guide
26
+
27
+        1. Overview
28
+        2. Dependencies
29
+
30
+              2.1. Kamailio Modules
31
+              2.2. External Libraries or Applications
32
+
33
+        3. Parameters
34
+
35
+              3.1. path (string)
36
+
37
+        4. Functions
38
+
39
+              4.1. geoip_match(ipaddr, pvc)
40
+
41
+        5. Exported pseudo-variables
42
+
43
+   List of Examples
44
+
45
+   1.1. Set path parameter
46
+   1.2. geoip_match usage
47
+
48
+Chapter 1. Admin Guide
49
+
50
+   Table of Contents
51
+
52
+   1. Overview
53
+   2. Dependencies
54
+
55
+        2.1. Kamailio Modules
56
+        2.2. External Libraries or Applications
57
+
58
+   3. Parameters
59
+
60
+        3.1. path (string)
61
+
62
+   4. Functions
63
+
64
+        4.1. geoip_match(ipaddr, pvc)
65
+
66
+   5. Exported pseudo-variables
67
+
68
+1. Overview
69
+
70
+   This module allows real-time queries against the Max Mind GeoIP
71
+   database to be performed from the config script. It uses the old
72
+   version of API, still very common on OS distributions. For using the
73
+   new version of GeoIP API, see geoip2 module.
74
+
75
+   The Max Mind GeoIP database is a map of IP network address assignments
76
+   to geographical locales that can be useful -- though approximate -- in
77
+   identifying the physical location with which an IP host address is
78
+   associated on a relatively granular level.
79
+
80
+   This database itself can be obtained on a free or commercial basis from
81
+   http://www.maxmind.com/app/ip-location. The library that interfaces
82
+   with the Max Mind API, as well as scripts to automate downloading of
83
+   the on-disk version of the open-source database is also packaged by the
84
+   Debian Linux distribution and its derivatives as libgeoip, and probably
85
+   by other distributions as well.
86
+
87
+   Debian Linux squeeze includes already a database as dependency, but as
88
+   this contain the wrong data, it will not work correctly with the
89
+   module. More acurate, the module expect the GeoIP City Edition, and
90
+   will not work with the GeoIP Country Edition. In newer Debian Linux
91
+   releases the package geoip-database-contrib should contain the
92
+   necessary database. You can download the Lite edition of the DB from
93
+   http://www.maxmind.com/app/geolitecity.
94
+
95
+   This module exports a new class of pseudo-variables - $gip(pvc=>key) -
96
+   to enable access to the results of a query to the database.
97
+
98
+   Many queries can be done and store results in different containers to
99
+   be able to use in parallel. Database is loaded at startup in cache.
100
+
101
+2. Dependencies
102
+
103
+   2.1. Kamailio Modules
104
+   2.2. External Libraries or Applications
105
+
106
+2.1. Kamailio Modules
107
+
108
+   The following modules must be loaded before this module:
109
+     * none.
110
+
111
+2.2. External Libraries or Applications
112
+
113
+   The following libraries or applications must be installed before
114
+   running Kamailio with this module loaded:
115
+     * libgeoip - the GeoIP library.
116
+
117
+3. Parameters
118
+
119
+   3.1. path (string)
120
+
121
+3.1. path (string)
122
+
123
+   Path to the GeoIP database file.
124
+
125
+   Default value is “null”.
126
+
127
+   Example 1.1. Set path parameter
128
+...
129
+modparam("geoip", "path", "/usr/local/share/GeoLiteCity.dat")
130
+...
131
+
132
+4. Functions
133
+
134
+   4.1. geoip_match(ipaddr, pvc)
135
+
136
+4.1.  geoip_match(ipaddr, pvc)
137
+
138
+   Match ipaddr against the GeoIP database and set the pvc container. The
139
+   function has to be called before accessing a key via: $gip(pvc=>key).
140
+
141
+   Example 1.2. geoip_match usage
142
+...
143
+if(geoip_match("$si", "src"))
144
+    xlog("SIP message from: $gip(src=>cc)\n");
145
+...
146
+
147
+5. Exported pseudo-variables
148
+
149
+     * $gip(pvc=>key) - pvc is an identifier for this query result; it is
150
+       designated by the second parameter of geoip_match(). The key can be
151
+       one of the following:
152
+          + cc - country code
153
+          + tz - time zone
154
+          + zip - postal code
155
+          + lat - latitude
156
+          + lon - longitude
157
+          + dma - dma code
158
+          + ips - ip start
159
+          + ipe - ip end
160
+          + city - city
161
+          + area - area code
162
+          + regc - region
163
+          + regn - region name
164
+          + metro - metro code
165
+          + contc - continent code
166
+
167
+   Exported pseudo-variables are documented at
168
+   http://www.kamailio.org/wiki/.