From 217190a0b33027f6a7bf6a388601864d232495c1 Mon Sep 17 00:00:00 2001 From: Ulf Seltmann <seltmann@ub.uni-leipzig.de> Date: Thu, 26 Apr 2018 13:58:14 +0200 Subject: [PATCH] updated documentation --- Readme.md | 10 ++++++---- docs/Readme.md | 10 ++++++---- docs/index.md | 9 +++++++-- 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/Readme.md b/Readme.md index 0c0f5d5..52909c4 100644 --- a/Readme.md +++ b/Readme.md @@ -1,10 +1,10 @@ # 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. - [](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master) [](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 diff --git a/docs/Readme.md b/docs/Readme.md index 0c0f5d5..1aac0d9 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,10 +1,10 @@ # 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. - [](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master) [](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 diff --git a/docs/index.md b/docs/index.md index e5c4c2e..ec7b284 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,8 @@ # dacap +[](https://git.sc.uni-leipzig.de/ubl/bdd_dev/dacap/commits/master) +[](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 -- GitLab