r4sas/yggdrasil-api
1
0
Fork 0
mirror of https://github.com/r4sas/Niflheim-api synced 2025-02-11 06:24:15 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
yakamok 2018-11-21 18:21:25 +01:00 committed by GitHub
parent 3b1eed1ff1
commit 90070148d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
api/README.md
View File

@ -1,5 +1,20 @@
# yggapi.py
# niflheim-api.py
This api provides a web interface to see some basic stats on the data vserv.py has collected and also provides and easy way to get the data through the api.
![api](https://github.com/yakamok/ygg-node-db/blob/master/api.png)
## Install & Setup
First thing you are going to do is configure niflheim-api.py to use the Postgres databse you setup for vserv.py.
So open niflheim-api.py:
DB_PASSWORD = "password"
DB_USER = "yggindex"
DB_NAME = "yggindex"
DB_HOST = "localhost"
Make sure the above matches what you have in vserv.py.
The API will startup on port 3000 and accept all ipv6 connections if you want to change this edit the last line:
app.run(host='::', port=3000)