a/startpage-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
startpage-engine/docs/CONFIG.md
aria 4080395342 first version
2022-01-17 13:58:51 -05:00

1.2 KiB
Raw Permalink Blame History

Config

The default config is located here.

public meaning

Public is meant to determine if your SPE server will allow others to serve people-other-than-yourselves needs.

For example, if public is true, the server will allow queries to locations besides your own in the API. If it's false, it will only accept API calls to your location.

all other meanings

This is the default config.

{
  "port": 9090,
  "public": true,
  "defaults": {
    "open-weather-city-id": "5110629",
    "open-weather-measure": "imperial",
    "news-tags": ["coronavirus", "covid"]
  }
}
  • port is where the API will be hosted.
  • public was just discussed above. Determines weather or not to allow other people to use this API.
  • defaults are the default values set by the owner. Made to make URLs to request not be as long.
    • open-weather-city-id is the ID for your weather map. To get this, go to OpenWeatherMap.org and search for your city.
    • open-weather-city-measure is the measurement you plan to accept your weather in. Flavors accepted are imperial and metric.
    • news-tags are tags to search Google News for by default.