jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 1 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 2 | .\" * OsmoGGSN - Gateway GPRS Support Node |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 3 | .\" * Copyright (C) 2002, 2003 Mondru AB. |
| 4 | .\" * |
| 5 | .\" * The contents of this file may be used under the terms of the GNU |
| 6 | .\" * General Public License Version 2, provided that the above copyright |
| 7 | .\" * notice and this permission notice is included in all copies or |
| 8 | .\" * substantial portions of the software. |
| 9 | .\" * |
| 10 | .\" * The initial developer of the original code is |
| 11 | .\" * Jens Jakobsen <jj@openggsn.org> |
| 12 | .\" * |
| 13 | .\" * Contributor(s): |
| 14 | .\" * |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 15 | .\" Manual page for osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 16 | .\" SH section heading |
| 17 | .\" SS subsection heading |
| 18 | .\" LP paragraph |
| 19 | .\" IP indented paragraph |
| 20 | .\" TP hanging label |
| 21 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 22 | .TH osmo-ggsn 8 "August 2017" |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 23 | .SH NAME |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 24 | osmo-ggsn \- Gateway GPRS Support Node. |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 25 | .SH SYNOPSIS |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 26 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 27 | \-\-help |
| 28 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 29 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 30 | \-\-version |
| 31 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 32 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 33 | [ |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 34 | .BI \-\-help |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 35 | ] [ |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 36 | .BI \-\-daemonize |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 37 | ] [ |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 38 | .BI \-\-config-file " file" |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 39 | ] [ |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 40 | .BI \-\-version |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 41 | ] |
| 42 | .SH DESCRIPTION |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 43 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 44 | is part of the |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 45 | .B OsmoGGSN |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 46 | project, and implements a Gateway GPRS Support Node. It is used by |
| 47 | mobile operators as the interface between the Internet and the rest of |
| 48 | the mobile network infrastructure. |
| 49 | |
| 50 | The GPRS functionality and protocols has been standardised by the |
| 51 | Third Generation Partnership Project (3GPP). According to the 3GPP |
| 52 | specifications a GGSN has two interfaces: The Gn/Gp interface and the |
| 53 | Gi interface. |
| 54 | |
| 55 | The Gn/Gp interface can be seen as the downlink interface of the |
| 56 | GGSN. It is used for communicating with the Serving GPRS Support Node |
| 57 | (SGSN) which again interfaces to the radio access network. The Gn/Gp |
| 58 | interface uses the GPRS tunneling protocol (GTP). User data packets |
| 59 | (typically IP packets) are tunneled over GTP, which again uses UDP |
| 60 | over IP. |
| 61 | |
| 62 | The other interface can be thought of as the uplink interface, and |
| 63 | interfaces the GGSN to an external data network. Gi is most often an |
| 64 | interface to the Internet. |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 65 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 66 | uses the |
| 67 | .B TUN/TAP driver |
| 68 | for the Gi interface. A tun network interface is established when the |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 69 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 70 | is started. |
| 71 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 72 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 73 | will accept incoming connections from mobile stations through the |
| 74 | radio access network and the SGSN. When a connection request is |
| 75 | received the ggsn will allocate a dynamic IP address for the mobile |
| 76 | station, and allow the mobile station to access the Gi |
| 77 | interface. Connections are terminated by either the mobile station or |
Holger Hans Peter Freyther | 9c7fd8e | 2014-12-04 16:32:37 +0100 | [diff] [blame] | 78 | the SGSN. Runtime errors are reported using the Osmocom logging |
| 79 | framework. |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 80 | |
| 81 | Typically |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 82 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 83 | will be deployed with two Ethernet interfaces. One for the Gn/Gp |
| 84 | interface, and one for the Gi interface. Policy routing and firewall |
| 85 | rules should be used in order to separate Gi traffic from Gn/Gp |
| 86 | traffic. |
| 87 | |
| 88 | .SH OPTIONS |
| 89 | .TP |
| 90 | .BI --help |
| 91 | Print help and exit. |
| 92 | |
| 93 | .TP |
| 94 | .BI --version |
| 95 | Print version and exit. |
| 96 | |
| 97 | .TP |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 98 | .BI --daemonize |
| 99 | Run in background as a daemon (default = off) |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 100 | |
| 101 | .TP |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 102 | .BI --config-file " file" |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 103 | Read configuration |
| 104 | .I file |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 105 | (default = ./openggsn.cfg) |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 106 | |
| 107 | .SH FILES |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 108 | .I ./osmo-ggsn.cfg |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 109 | .RS |
| 110 | The configuration file for |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 111 | .B osmo-ggsn. |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 112 | .RE |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 113 | .I /var/run/osmo-ggsn.pid |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 114 | .RS |
| 115 | Process ID file. |
| 116 | .RE |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 117 | .I /var/lib/osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 118 | .RS |
| 119 | Directory holding nonvolatile data. |
| 120 | .RE |
| 121 | |
| 122 | .SH BUGS |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 123 | Report all bugs to the OsmoGGSN bug tracking list at |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 124 | .I https://osmocom.org/projects/openggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 125 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 126 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 127 | has very limited management support. Currently both SNMP as well as |
| 128 | billing mechanisms are missing. |
| 129 | |
| 130 | |
| 131 | .SH "SEE ALSO" |
Holger Hans Peter Freyther | 9c7fd8e | 2014-12-04 16:32:37 +0100 | [diff] [blame] | 132 | .BR sgsnemu (8) |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 133 | |
| 134 | .SH NOTES |
| 135 | .LP |
| 136 | |
| 137 | Besides the long options documented in this man page |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 138 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 139 | also accepts a number of short options with the same functionality. Use |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 140 | .B osmo-ggsn --help |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 141 | for a full list of all the available options. |
| 142 | |
| 143 | The TUN/TAP driver is required for proper operation of |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 144 | .B osmo-ggsn. |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 145 | For linux kernels later than 2.4.7 the TUN/TAP driver is included in the kernel, but typically needs to be loaded manually with |
| 146 | .B modprobe tun. |
| 147 | For automatic loading the line |
| 148 | .B alias char-major-10-200 tun |
| 149 | can be added to |
| 150 | .B /etc/modules.conf. |
| 151 | For other platforms see |
| 152 | .I http://vtun.sourceforge.net/tun/ |
| 153 | for information on how to install and configure the tun driver. |
| 154 | |
Harald Welte | 632e843 | 2017-09-05 18:12:14 +0200 | [diff] [blame] | 155 | .B osmo-ggsn |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 156 | uses the GPRS Tunneling Protocol (GTP) as specified by the Third |
| 157 | Generation Partnership Project (3GPP). 3GPP protocols specifications |
| 158 | can be found at |
| 159 | .I http://www.3gpp.org |
| 160 | |
| 161 | .SH COPYRIGHT |
| 162 | |
| 163 | Copyright (C) 2002, 2003 by Mondru AB. |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 164 | Copyright (C) 2017 Harald Welte |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 165 | |
| 166 | The contents of this file may be used under the terms of the GNU |
| 167 | General Public License Version 2, provided that the above copyright |
| 168 | notice and this permission notice is included in all copies or |
| 169 | substantial portions of the software. |
| 170 | |
| 171 | .SH AUTHORS |
| 172 | Jens Jakobsen <jj@openggsn.org> |
Harald Welte | dda21ed | 2017-08-12 15:07:02 +0200 | [diff] [blame] | 173 | Harald Welte <laforge@gnumonks.org> |