Welcome to the CoatRack Wiki!

Here you can get some general information about CoatRack as well as specific guidelines for Developers, for Installation and Administration.

If you find any security vulnerabilities, please create an issue with the label security. Any sensitive information can be mailed to info@coatrack.eu including the issue number.

If you want to give CoatRack a try:

• Go to CoatRack.eu
• Log in with your Github account
• Start one of the Tutorials

CoatRack is an API gateway management framework that supports:

• Monitoring APIs calls
• Authentication/Authorization of API calls
• Monetization of APIs

CoatRack consists of:

• Distributed, lightweight API gateways
• A centralized web application to generate and manage the API gateways.

The following figure shows a typical architecture. The calls to a software service API are routed and logged by a custom CoatRack Gateway, which can be install in the service provider's local network. Configuration and statistics are accessible via the CoatRack website.

• If you want to build CoatRack or contribute to its development, check out the Developer Guidelines
• If you want to install CoatRack on your server, check out the Installation Guidelines
• If you want to administrate your CoatRack installation, see the Administration Guidelines

Scripts for building and running CoatRack are available in the root folder of the code base. To build CoatRack, use:

./build.sh 

To run your locally built CoatRack admin web application, use the following command (you also have the option to use a custom Spring profile by passing its name to the start script):

./run-admin-application.sh [optional-spring-profile-name]

After starting up, the CoatRack web application will be accessible at http://localhost:8080.

To create your personal custom Spring profile for CoatRack, please follow the instructions in the following template file:

spring-boot/admin/src/main/resources/application-private-TEMPLATE.yml