Fix local server for multiple applications
[anna.git] / INSTALL_ADML_HTTP.md
index 973862b..e3aa9ae 100644 (file)
@@ -2,19 +2,21 @@
 
 ## Deployment
 
-Execute this [script](./example/diameter/launcher/deploy-adml-http.sh) and follow instructions.
+Execute this [script](./example/diameter/launcher/deploy-adml-http.sh [Variant: Release by default]) and follow instructions.
 
-## Enabling HTTP2 Service
+## Building docker image
 
-This is done through nginx proxy configured as reverse proxy to translate `HTTP2` traffic coming to port *8074* towards *localhost* port *8000* where `ADML HTTP` is going to serve the *HTTP1.1* Rest Service.
+In our image, we enable the `HTTP2 Service` to attack the `HTTP1.1 ADML interface`. This is done through nginx proxy configured as reverse proxy to translate `HTTP2` traffic coming to port *8074* towards *localhost* port *8000* where `ADML HTTP` is going to serve the *HTTP1.1* Rest Service.
 
 To build the docker image, execute this script:
 
-> tools/build-adml-http [variant: [Release]|Debug]
+> tools/build-anna-adml-http [variant: [Release]|Debug]
 
 ## Running docker image
 
-> docker run --rm -d -p 8074:8074 --name adml-http anna-adml-http:<version>
+> docker run --rm -d -p 8074:8074 --name anna-adml-http anna-adml-http:<version> [entrypoint arguments: <[ft]|st>]
+
+Entrypoint arguments are passed to ADML start script (`/opt/adml/start.sh` inside the container), and are mainly preconfigured variants for `ADML` command-line arguments. So, `ft` stands for `function test` (debug traces, traffic logs in real time, etc.) and `st` is `system test` (warning level for traces, no traffic logs dumped, etc.).
 
 Service port is **8074**.
 
@@ -22,11 +24,11 @@ Service port is **8074**.
 
 ### Monitoring ADML traces
 
-> docker exec -it adml-http tail -F /opt/adml/launcher.trace
+> docker exec -it anna-adml-http tail -F /opt/adml/launcher.trace
 
 ### Checking available diameter dictionaries
 
-> docker exec -it adml-http ls -1 /opt/adml/stacks
+> docker exec -it anna-adml-http ls -1 /opt/adml/stacks
 >
 > DictionaryGx.16777238.xml
 > DictionaryRx.16777236.xml