mirror of
https://github.com/status-im/miniupnp.git
synced 2025-01-11 14:44:16 +00:00
Try to update README and INSTALL files
This commit is contained in:
parent
4510da6065
commit
cd87891cd7
@ -1,18 +1,24 @@
|
||||
Project: miniupnp
|
||||
Project web page: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
|
||||
github: https://github.com/miniupnp/miniupnp
|
||||
freecode: http://freecode.com/projects/miniupnp
|
||||
Author: Thomas Bernard
|
||||
Copyright (c) 2005-2011 Thomas Bernard
|
||||
Copyright (c) 2005-2012 Thomas Bernard
|
||||
This software is subject to the conditions detailed in the
|
||||
LICENSE file provided within this distribution.
|
||||
|
||||
|
||||
For the comfort of Win32 users, bsdqueue.h is included in the distribution.
|
||||
Its licence is included in the header of the file.
|
||||
bsdqueue.h is a copy of the sys/queue.h of an OpenBSD system.
|
||||
|
||||
* miniupnp Client *
|
||||
|
||||
* miniUPnP Client - miniUPnPc *
|
||||
|
||||
To compile, simply run 'gmake' (could be 'make' on your system).
|
||||
Under win32, to compile with MinGW, type "mingw32make.bat".
|
||||
MS Visual C solution and project files are supplied in the msvc/ subdirectory.
|
||||
|
||||
The compilation is known to work under linux, FreeBSD,
|
||||
OpenBSD, MacOS X, AmigaOS and cygwin.
|
||||
The official AmigaOS4.1 SDK was used for AmigaOS4 and GeekGadgets for AmigaOS3.
|
||||
@ -23,7 +29,7 @@ To install the library and headers on the system use :
|
||||
> make install
|
||||
> exit
|
||||
|
||||
alternatively, to install in a specific location, use :
|
||||
alternatively, to install into a specific location, use :
|
||||
> INSTALLPREFIX=/usr/local make install
|
||||
|
||||
upnpc.c is a sample client using the libminiupnpc.
|
||||
@ -41,6 +47,7 @@ and -lminiupnpc for the link
|
||||
|
||||
Discovery process is speeded up when MiniSSDPd is running on the machine.
|
||||
|
||||
|
||||
* Python module *
|
||||
|
||||
you can build a python module with 'make pythonmodule'
|
||||
|
@ -1,7 +1,8 @@
|
||||
MiniUPnP project.
|
||||
(c) 2006-2011 Thomas Bernard
|
||||
(c) 2006-2012 Thomas Bernard
|
||||
Homepage : http://miniupnp.free.fr/
|
||||
Mirror: http://miniupnp.tuxfamily.org/
|
||||
github: https://github.com/miniupnp/miniupnp
|
||||
|
||||
miniupnpd is still under active developpement. This documentation is
|
||||
likely to be a little outdated when you read it. So please go on the
|
||||
@ -13,6 +14,9 @@ To Build and Install :
|
||||
- use BSD make to compile.
|
||||
- you can first 'make config.h' then edit config.h to your preferences and
|
||||
finally 'make'
|
||||
Alternatively to editing config.h, options can be passed to genconfig.sh
|
||||
For more details :
|
||||
> ./genconfig.sh -h
|
||||
- add "rdr-anchor miniupnpd" and "anchor miniupnpd" lines to /etc/pf.conf
|
||||
- some FreeBSD users reported that it is also necessary for them
|
||||
to explicitly allow udp traffic on 239.0.0.0/8 by adding the two following
|
||||
@ -29,7 +33,7 @@ To Build and Install :
|
||||
# PREFIX=/usr/local make install
|
||||
- run as root : The daemon needs rights to modify pf rules.
|
||||
|
||||
edit the /etc/miniupnpd.conf file to set options. All options are also
|
||||
edit the /etc/miniupnpd.conf file to set options. Almost all options are also
|
||||
available through command line switches.
|
||||
To stop the daemon use :
|
||||
> kill `cat /var/run/miniupnpd.pid`
|
||||
@ -46,9 +50,11 @@ http://blogs.sun.com/avalon/category/IPFilter
|
||||
|
||||
============================= Mac OS X/ipfw ===============================
|
||||
|
||||
- To enable non standard compilation options,
|
||||
> ./genconfig.sh -h
|
||||
Or edit config.h after it has been generated by genconfig.sh
|
||||
- use 'bsdmake' or 'make -f Makefile.macosx' to build
|
||||
|
||||
|
||||
============================ Linux/netfilter ==============================
|
||||
To Build and install :
|
||||
|
||||
@ -86,6 +92,7 @@ NOTE: a /etc/init.d/miniupnpd script will be installed.
|
||||
|
||||
|
||||
How to get libiptc with its headers on debian :
|
||||
(Note: that should be useless now that netfilter/tiny_nf_nat.h is included)
|
||||
- Use apt-get to get sources :
|
||||
> apt-get source iptables
|
||||
you should then have an iptables-x.x.x/ directory.
|
||||
@ -97,8 +104,8 @@ How to get libiptc with its headers on debian :
|
||||
> IPTABLESPATH=§path/to/iptables-x.x.x make -f Makefile.linux
|
||||
|
||||
=========================== Configuration =============================
|
||||
Edit the /etc/miniupnpd.conf file to set options. All options are also
|
||||
available through command line switches.
|
||||
Edit the /etc/miniupnpd.conf file to set options. Almost all options are
|
||||
also available through command line switches.
|
||||
|
||||
Miniupnpd supports some kind of security check for allowing or disallowing
|
||||
redirection to be made. The UPnP permission rules are read from the
|
||||
|
@ -1,9 +1,11 @@
|
||||
MiniUPnP project
|
||||
(c) 2006-2012 Thomas Bernard
|
||||
webpage: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
|
||||
github: https://github.com/miniupnp/miniupnp
|
||||
freecode: http://freecode.com/projects/miniupnp
|
||||
contact: miniupnp@free.fr
|
||||
|
||||
This directory contain the miniUPnP daemon software.
|
||||
This directory contain the miniUPnP daemon software, aka miniUPnPd.
|
||||
This software is subject to the conditions detailed in
|
||||
the LICENSE file provided with this distribution.
|
||||
|
||||
@ -13,8 +15,8 @@ which provide NAT traversal services to any UPnP enabled client on
|
||||
the network.
|
||||
See http://www.upnp.org/ for more details on UPnP.
|
||||
During the year 2011, support for IGD v2 has been added.
|
||||
This support is experimental, and should be enabled only
|
||||
for testing and development.
|
||||
In 2012, IGD v2 WANIPv6FirewallControl has been implemented.
|
||||
It is not yes enabled by default because it still needs testing.
|
||||
|
||||
Support for the NAT Port Mapping Protocol (NAT-PMP) has been
|
||||
added. See information about NAT-PMP here :
|
||||
@ -23,8 +25,9 @@ http://miniupnp.free.fr/nat-pmp.html
|
||||
Read the INSTALL files for instructions to compile, install and
|
||||
configure miniupnpd.
|
||||
|
||||
Report bugs to miniupnp@free.fr or on the web forum :
|
||||
Report bugs to miniupnp@free.fr on the web forum
|
||||
http://miniupnp.tuxfamily.org/forum/
|
||||
or using https://github.com/miniupnp/miniupnp/issues
|
||||
|
||||
Thomas Bernard
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user