Skip to content

Rest Backend Server

Nicho edited this page Oct 8, 2024 · 11 revisions

Description

This service embeded in MTGCompanion will expose many functions you have in the desktop client in web endpoints. You can find the swagger here : https://app.swaggerhub.com/apis/MTGCompanion/MTGCompanion3/

Web Servers

this server is used for the many Website Servers embeded in MTGCompanion. Please make sure this service available.

Securisation

Running on https

  1. Put the variable ENABLE_SSL to true
  2. make sure the KEYSTORE_URI variable is the good .jks file
  3. make sure the KEYSTORE_PASS variable is filled with the good .jks password
  4. add your public and privatekey certs in the keystore.
  5. restart the server.

Block external IP

if you want to block some external IP, you can fill list of address in BLOCKED_IPS , separated by comma. Then, restart the server.

Enable access control

You can fill the Access-Control-Allow-Origin field to control who can access to your service.

* : A response that tells the browser to allow code from any origin to access a resource

<url> : A response that tells the browser to allow requesting code from the origin <url>

Clone this wiki locally