n2n/doc/Scripts.md

# Scripts

There are a number of useful scripts included with the distribution.
Some of these scripts are only useful during build and development, but
other scripts are intended for end users to be able to use.  These scripts
may be installed with n2n as part of your operating system package.

Short descriptions of these scripts are below.

## `scripts/hack_fakeautoconf`

This shell script is used during development to help build on Windows
systems.  An example of how to use it is shown in
the [Building document](Building.md)

## `tools/test_harness`

This shell script is used to run automated tests during development.

## `scripts/n2nctl`

This python script provides an easy command line interface to the running
edge.  It uses UDP communications to talk to the Management API.

Example:
- `scripts/n2nctl --help`
- `scripts/n2nctl help`

## `scripts/n2nhttpd`

This python script is a simple http gateway to the running edge.  It provides
a proxy for REST-like HTTP requests to talk to the Management API.

By default it runs on port 8080.

It also provides a simple HTML page showing some information, which when
run with default settings can be seen at http://localhost:8080/

Example:
- `scripts/n2nhttpd --help`
- `scripts/n2nhttpd 8087`
Cleanup and Documentation for JSON management API (#856) * Reimplement JSON mgmt with clear separation of read/write actions * Reduce boilerplate by using a table driven command definition for json mgmt commands * Port tools to use new json api * Add a basic authentication for json mgmt commands * If a auth key is given, it must match * Add auth key to management scripts * Add a flag bitfield to clearly turn the tag param into a options list * Allow simple pass-through of any command from n2nctl * Convert the n2nctl to use an object oriented interface * Handle sigpipe in the n2nhttpd - this happens if the remote client disconnects unexpectely * Remove some repetition from the server * Use the correct options to allow reuseaddr * Dont generate a scary message on ctrl-c * Convert n2nhttpd to use object based RPC * Use the same longopt for both tools * Pass any extra args through to the RPC * Add some documentation for the scripts in the repository * Spelling fix * Add documentation for the JSON reply mangement API 2021-10-17 22:16:42 +02:00			`# Scripts`

			`There are a number of useful scripts included with the distribution.`
			`Some of these scripts are only useful during build and development, but`
			`other scripts are intended for end users to be able to use. These scripts`
			`may be installed with n2n as part of your operating system package.`

			`Short descriptions of these scripts are below.`

			## `scripts/hack_fakeautoconf`

			`This shell script is used during development to help build on Windows`
			`systems. An example of how to use it is shown in`
			`the [Building document](Building.md)`

			## `tools/test_harness`

			`This shell script is used to run automated tests during development.`

			## `scripts/n2nctl`

			`This python script provides an easy command line interface to the running`
			`edge. It uses UDP communications to talk to the Management API.`

			`Example:`
			- `scripts/n2nctl --help`
			- `scripts/n2nctl help`

			## `scripts/n2nhttpd`

			`This python script is a simple http gateway to the running edge. It provides`
			`a proxy for REST-like HTTP requests to talk to the Management API.`

			`By default it runs on port 8080.`

			`It also provides a simple HTML page showing some information, which when`
			`run with default settings can be seen at http://localhost:8080/`

			`Example:`
			- `scripts/n2nhttpd --help`
			- `scripts/n2nhttpd 8087`