Server

Installation

Docker

docker run -p 8080:8080 ghcr.io/wikinewsfeed/wikinewsfeed:latest

Configuration

Configuration is applied using Environment variables

Variable	Type	Default	Description
PORT	String	8080	Listen to port
WNF_URL	String, URL	http://localhost:8080	URL to be displayed in readers
WNF_MAXAGE	String	1800	Cache-Control age (only useful behind a CDN)
WNF_DB	Path	stats.db	Path where database file should be saved
WNF_CORS	String	*	CORS Header

Recommendations

Default response times from Wikipedia range 600-2000ms. Therefor it is absolutely necessary to run the server behind a caching proxy if you want a quick response

Here's example configuration for varnish, that will work with the default settings:

vcl 4.1;

backend default {
    .host = "0.0.0.0";
    .port = "8080";
}

Monitoring

/metrics exposes Prometheus metrics, following metrics are included

wnf_subscribers_total
wnf_hits_total
wnf_subscriber_hits_total
wnf_subscriber_unique_hits_total

Building

Clone the repository

git clone https://github.com/WikiNewsFeed/wikinewsfeed.git

Build using Docker

docker build -t wikinewsfeed/wikinewsfeed .

Build from source

• Go v1.16 and greater
• NodeJS optionally if you want to build the docs

1. Build the binary

Install the dependencies

go mod download

Build

go build

2. Build the docs

Install the dependencies

npm i

(Optionally) Preview the changes

npm run docs:dev

Build

npm run docs:build