-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ethan Kaley
committed
Aug 25, 2016
1 parent
8cc39fd
commit aca57cc
Showing
1 changed file
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,43 @@ | ||
# nm-rackhd | ||
# Neighborhood-Manager RackHD Proxy | ||
|
||
## Host System Requirements | ||
|
||
You will need to install the below programs on your host system: | ||
|
||
1. **Docker** version [1.12] or greater is required. | ||
2. **Docker-Compose** [latest] | ||
|
||
Once these two programs are installed a reboot may be needed. | ||
|
||
## Installation | ||
|
||
git clone https://github.com/RackHD/neighborhood-manager.git | ||
|
||
then | ||
|
||
cd neighborhood-manager | ||
|
||
|
||
## Deployment | ||
|
||
make run-proxy | ||
|
||
## Usage | ||
|
||
Some test commands | ||
|
||
curl http://localhost:10001/test | ||
|
||
returns that the proxy is alive | ||
|
||
curl http://localhost:10001/array | ||
|
||
returns an array of objects | ||
|
||
curl http://localhost:10001/object | ||
|
||
returns an object | ||
|
||
|
||
[1.12]: https://docs.docker.com/ | ||
[latest]: https://docs.docker.com/compose/install/ |