31 lines
968 B
Markdown
31 lines
968 B
Markdown
# ArmA Reforger Update Notification API
|
|
|
|
This tool pulls down the steamdb updates RSS feed and extracts each updates version, build number, and publish date then exposes them via a http endpoint.
|
|
|
|
## Install Methods
|
|
|
|
### Nix Package(prefered method)
|
|
|
|
### RPM
|
|
|
|
### Go(Not Supported)
|
|
|
|
1. Install [Go](https://go.dev/learn/)
|
|
2. Download the project source by running `git clone https://git.skdevstudios.com/specCon18/reforger-update-api.git`
|
|
3. Open a terminal and navigate to the project source
|
|
4. Run `go install .`
|
|
|
|
## Configuration
|
|
|
|
| Option | Default | Desired Value |
|
|
|----------------|---------|-----------------------------------|
|
|
| port | 3000 | any available port |
|
|
| cache_duration | 5m | time in minutes notated as <INT>m |
|
|
|
|
## Usage
|
|
### List of endpoints with required params
|
|
|
|
| Endpoint | Params |
|
|
|------------------|--------|
|
|
| updates | NONE |
|
|
| invalidate-cache | NONE |
|