Skip to content
This repository has been archived by the owner on Feb 2, 2023. It is now read-only.

Latest commit

 

History

History
55 lines (40 loc) · 1.9 KB

readme.md

File metadata and controls

55 lines (40 loc) · 1.9 KB

Impequid Service Provider

MIT License Code Climate NPM Downloads NPM Dependencies Gitter Chatroom

Provides information about impequid apps. Useful to prevent scams and exploits.

Intended Purpose

Assuming you want to setup your own Impequid server, you most likely don't want to manage all information about Apps yourself. So you can just use any Impequid Service Provider, and let it manage the App information.

The default Impequid Service provider is available at https://services.impequid.com.

Installation

  • Install Node.js
  • Install MongoDB
  • git clone https://github.com/dodekeract/impequid-service-provider
  • cd impequid-service-provider
  • npm install
  • npm run build

It is highly recommended to run Impequid Service Provider behind a reverse proxy, like Nginx.

Usage

  • Starting: npm run start
  • Re-building (after changes): npm run build

Configuration

Just add a config.json in impequid-service-provider's main directory. If you want to use this with docker, you should link /srv/node/config.json to your configuration file.

{
	"listen": {
		"host": "127.0.0.1",
		"port": 8080
	},
	"mongo": {
		"url": "mongodb://127.0.0.1/impequid-service-provider"
	},
	"server": {
		"name": "Server Name",
		"url": "server.url.com"
	}
}

Exposed API

See here.