aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/phayes/freeport/README.md
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-07-16 23:20:23 +0200
committerMichael Muré <batolettre@gmail.com>2018-07-16 23:23:43 +0200
commit1d678dfdfa026968dbb19795c9bed16385603b21 (patch)
treecac862609d0103ee30da39cd0054b11884248e9d /vendor/github.com/phayes/freeport/README.md
parent131a862d313f12808d63e832126317a27226940b (diff)
downloadgit-bug-1d678dfdfa026968dbb19795c9bed16385603b21.tar.gz
vendor dependencies with dep
Diffstat (limited to 'vendor/github.com/phayes/freeport/README.md')
-rw-r--r--vendor/github.com/phayes/freeport/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/vendor/github.com/phayes/freeport/README.md b/vendor/github.com/phayes/freeport/README.md
new file mode 100644
index 00000000..4f9245d9
--- /dev/null
+++ b/vendor/github.com/phayes/freeport/README.md
@@ -0,0 +1,54 @@
+FreePort
+========
+
+Get a free open TCP port that is ready to use.
+
+## Command Line Example:
+```bash
+# Ask the kernel to give us an open port.
+export port=$(freeport)
+
+# Start standalone httpd server for testing
+httpd -X -c "Listen $port" &
+
+# Curl local server on the selected port
+curl localhost:$port
+```
+
+## Golang example:
+```go
+package main
+
+import "github.com/phayes/freeport"
+
+func main() {
+ port, err := freeport.GetFreePort()
+ if err != nil {
+ log.Fatal(err)
+ }
+ // port is ready to listen on
+}
+
+```
+
+## Installation
+
+#### CentOS and other RPM based systems
+```bash
+wget https://github.com/phayes/freeport/releases/download/0.1.2/freeport_0.1.2_linux_386.rpm
+rpm -Uvh freeport_0.1.2_linux_386.rpm
+```
+
+#### Ubuntu and other DEB based systems
+```bash
+wget wget https://github.com/phayes/freeport/releases/download/0.1.2/freeport_0.1.2_linux_amd64.deb
+dpkg -i freeport_0.1.2_linux_amd64.deb
+```
+
+## Building From Source
+```bash
+sudo apt-get install golang # Download go. Alternativly build from source: https://golang.org/doc/install/source
+mkdir ~/.gopath && export GOPATH=~/.gopath # Replace with desired GOPATH
+export PATH=$PATH:$GOPATH/bin # For convenience, add go's bin dir to your PATH
+go get github.com/phayes/freeport/cmd/freeport
+```