Skip to content

Commit

Permalink
add readme and launch
Browse files Browse the repository at this point in the history
  • Loading branch information
RaidMax committed Jun 30, 2020
1 parent 894a504 commit 6146a7f
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 1 deletion.
5 changes: 4 additions & 1 deletion IW4MAdmin.Master.pyproj
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,15 @@ IW4MADMIN_AUTH_KEY=devdevdev</Environment>
</ItemGroup>
<ItemGroup>
<Content Include=".gitignore" />
<Content Include="requirements.txt" />
<Content Include="launch.sh" />
<Content Include="README.md" />
<Content Include="src\requirements.txt" />
<Content Include="src\config\master.v0.json" />
<Content Include="src\config\master.v1.json" />
<Content Include="src\master\templates\index.html" />
<Content Include="src\master\templates\layout.html" />
<Content Include="src\master\templates\serverlist.html" />
<Content Include="src\README.md" />
</ItemGroup>
<ItemGroup>
<Compile Include="src\master\context\base.py" />
Expand Down
Empty file added README.md
Empty file.
19 changes: 19 additions & 0 deletions launch.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#!/bin/bash

pyver="$(python3 -V 2>&1 | grep -Po '(?<=Python )(.+)')"
requiredver="3.4"

if [[ -z "$pyver" ]]
then
echo "Python 3 does not appear to be installed."
else
if [[ $pyver =~ $requiredver ]]
then
echo "Python Version is $pyver"
echo "Installing Requirements..."
pip install -r requirements.txt
python3 runserver.py
else
echo "Minimum Python version required is $requiredver"
fi
fi
33 changes: 33 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# IW4MAdmin-Master
### Purpose
**IW4MAdmin-Master** is the master list for all running instance of [IW4MAdmin](https://github.com/RaidMax/IW4M-Admin/)
Each **IW4MAdmin** instance sends a heartbeat approximately every 30 seconds which is recieved by this service and stored.
**IW4MAdmin-Master** is also responsible for maintaining the version information and providing current translation strings.

### Requirements
`Python 3.8.x` or newer

### Start (local)
```bash
chmod +x launch.sh
./launch.sh
```

### Endpoints
Unless otherwise specified, all endpoints return JSON
#### /Health
Health status of the master
#### /Instance
All active instances
#### /Version
Current stable and pre-release version
#### /History
Client and server count history
#### /Localization
Latest translation strings

### UI
#### Home
Zoomable plot of servers, client, and instance counts over an interval
#### /servers
Simple list of all server information grouped by game name
File renamed without changes.

0 comments on commit 6146a7f

Please sign in to comment.