Update readme.

This commit is contained in:
W1CDN 2023-04-11 20:55:58 -05:00
parent 23d52a80da
commit 0f1edd34af

View File

@ -7,9 +7,12 @@ direwolf logs into a REST API in JSON format.
## Setup ## Setup
1. Run direwolf with logging to CSV on by using `-l`. (`-L` not yet implemented). 1. Run direwolf with logging to CSV on by using `-l`. (`-L` not yet implemented).
1. Install requirements using `pip install -r requirements.txt`. 1. Install requirements using `pip install -r requirements.txt`.
2. Run `app.py` with either a Python call or gunicorn (or some other WSGI server). 2. Run `app.py` with either a Python call or a real WSGI server.
You can use screen to detach the session. You can use screen to detach the session.
- Default URL is http://127.0.0.1:5000 - Default URL is http://127.0.0.1:5000
- Example `waitress` and `screen` scripts are included, see
- `api_waitress.py` and
- `start-aprs_api.sh`
3. Access the API from whatever other system you want. 3. Access the API from whatever other system you want.
## Endpoints: ## Endpoints: