From c93916e9012d2d33dc1e8394889ee92892b8e78d Mon Sep 17 00:00:00 2001 From: Alexander Bouriakov Date: Mon, 3 Jul 2023 13:03:34 +0200 Subject: [PATCH] Certificate file names and minor fixes (#124) * small fixes * avoiding confusion with certificate names --- modules/ROOT/pages/first-look/linux-first-look.adoc | 12 ++++++------ .../pages/installation/self-signed-certificate.adoc | 7 ++++++- modules/ROOT/pages/installation/server.adoc | 3 ++- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/first-look/linux-first-look.adoc b/modules/ROOT/pages/first-look/linux-first-look.adoc index dd9e5440..896d86ff 100644 --- a/modules/ROOT/pages/first-look/linux-first-look.adoc +++ b/modules/ROOT/pages/first-look/linux-first-look.adoc @@ -67,16 +67,16 @@ More information on Self Signed certificates *xref:installation/self-signed-cert --spring.neo4j.authentication.password=lovelypassword \ --server.port=8080 \ --server.ssl.key-store-type=PKCS12 \ - --server.ssl.key-store=file:./certificates/localhost.pfx \ + --server.ssl.key-store=file:./certificates/server.pfx \ --server.ssl.key-store-password= \ --grpc.server.port=9090 \ --grpc.server.security.key-store-type=PKCS12 \ - --grpc.server.security.key-store=file:./certificates/localhost.pfx\ + --grpc.server.security.key-store=file:./certificates/server.pfx\ --grpc.server.security.key-store-password=\ --jwt.secret=please-set-a-random-secret-string-here-for-jwt-signing \ ---- -Running as console application on Unix is documented *xref:installation/server.adoc#_unix[here]* +Running as console application on Unix is documented *xref:installation/server.adoc#unix[here]* === Open NOM UI Wait for the server to start and then go to https://localhost:8080. @@ -87,7 +87,7 @@ Login as admin:passw0rd and accept license terms. In NOM UI - navigate to Agent settings (clicking on the sad robot takes you to the correct page) and add a new agent. Copy environment variables that are provided. -Full documentation on registering an agent is *xref:addition/index.adoc#register[here]*. +Full documentation on registering an agent is *xref:addition/agent-installation/index.adoc[here]*. === Unpack agent [source, terminal, role=noheader] @@ -107,7 +107,7 @@ Edit the export command below as follows: ---- export \ -CONFIG_TLS_TRUSTED_CERTS=/certificates/localhost.cer \ +CONFIG_TLS_TRUSTED_CERTS=/certificates/server.cer \ CONFIG_LOG_LEVEL=debug \ CONFIG_INSTANCE_1_NAME=server1 \ CONFIG_INSTANCE_1_BOLT_URI= \ @@ -130,7 +130,7 @@ CONFIG_INSTANCE_3_LOG_CONFIG_PATH=/conf/server-logs.xml ---- Run the edited export command. -Full documentation on configuring an agent is *xref:addition/index.adoc#configure[here]*. +Full documentation on configuring an agent is *xref:addition/agent-installation/index.adoc[here]*. === Run agent as console application diff --git a/modules/ROOT/pages/installation/self-signed-certificate.adoc b/modules/ROOT/pages/installation/self-signed-certificate.adoc index 6a4226d2..0a0491e3 100644 --- a/modules/ROOT/pages/installation/self-signed-certificate.adoc +++ b/modules/ROOT/pages/installation/self-signed-certificate.adoc @@ -63,4 +63,9 @@ java -jar ./lib/server.jar ssc -n localhost \ It generates a key pair and a self-signed certificate and creates `localhost.cer` and `localhost.pfx` files inside `./certificates` directory. `localhost.pfx` is assigned the password `changeit` which is provided to the command as an argument. -You can then use these two files to configure the server and agents for TLS encrypted communication. \ No newline at end of file +You can then use these two files to configure the server and agents for TLS encrypted communication. + +[IMPORTANT] +==== +Please note that in the rest of documentation, certificate files are referred to as `server.cer` and `server.pfx`. +==== diff --git a/modules/ROOT/pages/installation/server.adoc b/modules/ROOT/pages/installation/server.adoc index 8a4ae1f3..e190c72e 100644 --- a/modules/ROOT/pages/installation/server.adoc +++ b/modules/ROOT/pages/installation/server.adoc @@ -122,6 +122,7 @@ Although it is possible to run the NOM Server as a console application, it is no Best practice is to run the NOM Server as a service, as described in the previous section. ==== +[[unix]] === Unix ==== Passing arguments on command line @@ -194,7 +195,7 @@ java -jar .\lib\server.jar [NOTE] ==== -If the NOM Server is required to support self-registered agents, then addtional configuration needs to be provided to above commands as mentioned in the configuration reference table. More about agent self-registration xref:../addition/agent-installation/self-registered.adoc[here] +If the NOM Server is required to support self-registered agents, then additional configuration needs to be provided to above commands as mentioned in the configuration reference table. More about agent self-registration xref:../addition/agent-installation/self-registered.adoc[here] ==== == Server configuration reference [[config_ref]]