Skip to content
Snippets Groups Projects
Commit 217190a0 authored by Ulf Seltmann's avatar Ulf Seltmann
Browse files

updated documentation

parent 43543a44
Branches
Tags
No related merge requests found
Pipeline #308 passed with stages
in 1 minute and 35 seconds
# dacap
*Dynamic And Compressing Api Proxy* is a service which lets you proxy arbitrary API-Endpoints which are by themself to slow to be used in production environments. All cached Responses are held in memory, so be sure to provide enough.
[![pipeline status](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/badges/master/pipeline.svg)](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master)
[![coverage report](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/badges/master/coverage.svg)](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master)
*Dynamic And Compressing Api Proxy* is a service which lets you proxy arbitrary API-Endpoints which are by themself to slow to be used in production environments. All cached Responses are held in memory, so be sure to provide enough.
## Requirements
* node >= v8.2.1
......@@ -29,7 +29,7 @@ $# dacap
$# docker run -p 3000:3000 -v /my/hosts/data/folder:/data ubleipzig/dacap
```
You can customize multiple values, see [Advanced Configuration](#Advanced Configuration)
You can customize multiple values, see [Advanced Configuration]
## Usage
......@@ -68,4 +68,6 @@ The service can be configured by environment variables. The following are availa
* `user`: Specifies the user for simple basic authentication. Defaults to `undefined`.
* `password`: Specifies the password for simple basic authentication. Defaults to `undefined`.
**Only when both `user` and `password` are specified basic-auth is enabled**
\ No newline at end of file
**Only when both `user` and `password` are specified basic-auth is enabled**
[Advanced Configuration]: #Advanced-Configuration
\ No newline at end of file
# dacap
*Dynamic And Compressing Api Proxy* is a service which lets you proxy arbitrary API-Endpoints which are by themself to slow to be used in production environments. All cached Responses are held in memory, so be sure to provide enough.
[![pipeline status](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/badges/master/pipeline.svg)](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master)
[![coverage report](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/badges/master/coverage.svg)](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master)
*Dynamic And Compressing Api Proxy* is a service which lets you proxy arbitrary API-Endpoints which are by themself to slow to be used in production environments. All cached Responses are held in memory, so be sure to provide enough.
## Requirements
* node >= v8.2.1
......@@ -29,7 +29,7 @@ $# dacap
$# docker run -p 3000:3000 -v /my/hosts/data/folder:/data ubleipzig/dacap
```
You can customize multiple values, see [Advanced Configuration](#Advanced Configuration)
You can customize multiple values, see [Advanced Configuration]
## Usage
......@@ -68,4 +68,6 @@ The service can be configured by environment variables. The following are availa
* `user`: Specifies the user for simple basic authentication. Defaults to `undefined`.
* `password`: Specifies the password for simple basic authentication. Defaults to `undefined`.
**Only when both `user` and `password` are specified basic-auth is enabled**
\ No newline at end of file
**Only when both `user` and `password` are specified basic-auth is enabled**
[Advanced Configuration]: #Advanced-Configuration
# dacap
[![pipeline status](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/badges/master/pipeline.svg)](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master)
[![coverage report](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/badges/master/coverage.svg)](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master)
*Dynamic And Compressing Api Proxy* ist ein Dienst, der Ausgaben beliebiger API-Endpunkte zwischenspeichert. Der Dienst wurde erstellt, um API-Requests, welche durch den zur Verfügung stellenden Service nicht performant genug ausgeliefert werden können, zwischenzuspeichern und aus dem Cache auszuliefern zu können. Zusätzlich wird das Response gzip-komprimiert ausgeliefert und die Cache-Daten werden in einem eingestellten Interval im Hintergrund erneuert.
## Abhängigkeiten
......@@ -26,7 +29,7 @@ $# dacap
$# docker run -p 3000:3000 -v /my/hosts/data/folder:/data ubleipzig/dacap
```
Die Konfiguration wird über Umgebungsvariablen durchgeführt, siehe [erweiterte Konfiguration](#erweiterte Konfiguration)
Die Konfiguration wird über Umgebungsvariablen durchgeführt, siehe [erweiterte Konfiguration]
## Benutzung
......@@ -67,4 +70,6 @@ Der Dienst lässt sich über Umgebungsvariablen konfigurieren, die beim Start de
* `user`: Spezifiziert den Benutzer für die Basic Authentication. Standardmäßig `undefined`.
* `password`: Spezifiziert das Passwort für die Basic Authentication. Standardmäßig `undefined`.
**Nur wenn `user` und `password` angegeben sind, ist basic-auth aktiviert**
\ No newline at end of file
**Nur wenn `user` und `password` angegeben sind, ist basic-auth aktiviert**
[erweiterte Konfiguration]: #erweiterte-Konfiguration
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment