Skip to content

Commit 6444027

Browse files
committed
Added running instructions to the README.md
1 parent 936adc2 commit 6444027

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,21 @@ This work is protected by Copyright. Please refer to the [Copyright File](src/CO
1515
## License
1616

1717
REDHAWK REST Python is licensed under the GNU Lesser General Public License (LGPL).
18+
19+
## Running
20+
21+
For Development/Test environments there are scripts to automatically create a local environment and run the server.
22+
23+
./setup.py install
24+
./start.sh --port=<desired_port>
25+
26+
The tools above will create a virtual environment in the current directory.
27+
28+
For a more permanent solution, consult the `requirements.txt` and run the following command as a service:
29+
30+
./pyrest.py --port=<desired_port>
31+
32+
`supervisord` is a common tool for running commands as a service and a sample configuration snippet
33+
can be found at `deploy/rest-python-supervisor.conf`.
34+
35+
Once running the REST Interface can be tested at `http://localhost:<desired_port>/rh/rest/domains`.

0 commit comments

Comments
 (0)