Skip to content

Commit cc8fe13

Browse files
authored
Certificate file names and minor fixes (#124) (#130)
* small fixes * avoiding confusion with certificate names
1 parent 7664f6e commit cc8fe13

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

modules/ROOT/pages/first-look/linux-first-look.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,16 @@ More information on Self Signed certificates *xref:installation/self-signed-cert
6767
--spring.neo4j.authentication.password=lovelypassword \
6868
--server.port=8080 \
6969
--server.ssl.key-store-type=PKCS12 \
70-
--server.ssl.key-store=file:./certificates/localhost.pfx \
70+
--server.ssl.key-store=file:./certificates/server.pfx \
7171
--server.ssl.key-store-password=<PASSWORD> \
7272
--grpc.server.port=9090 \
7373
--grpc.server.security.key-store-type=PKCS12 \
74-
--grpc.server.security.key-store=file:./certificates/localhost.pfx\
74+
--grpc.server.security.key-store=file:./certificates/server.pfx\
7575
--grpc.server.security.key-store-password=<PASSWORD>\
7676
--jwt.secret=please-set-a-random-secret-string-here-for-jwt-signing \
7777
----
7878

79-
Running as console application on Unix is documented *xref:installation/server.adoc#_unix[here]*
79+
Running as console application on Unix is documented *xref:installation/server.adoc#unix[here]*
8080

8181
=== Open NOM UI
8282
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.
8787
In NOM UI - navigate to Agent settings (clicking on the sad robot takes you to the correct page) and add a new agent.
8888
Copy environment variables that are provided.
8989

90-
Full documentation on registering an agent is *xref:addition/index.adoc#register[here]*.
90+
Full documentation on registering an agent is *xref:addition/agent-installation/index.adoc[here]*.
9191

9292
=== Unpack agent
9393
[source, terminal, role=noheader]
@@ -107,7 +107,7 @@ Edit the export command below as follows:
107107
----
108108
export \
109109
<OUTPUT_FROM_REGISTER_AGENT>
110-
CONFIG_TLS_TRUSTED_CERTS=<SERVER_INSTALL_DIR>/certificates/localhost.cer \
110+
CONFIG_TLS_TRUSTED_CERTS=<SERVER_INSTALL_DIR>/certificates/server.cer \
111111
CONFIG_LOG_LEVEL=debug \
112112
CONFIG_INSTANCE_1_NAME=server1 \
113113
CONFIG_INSTANCE_1_BOLT_URI=<SERVER_1_BOLT_URI> \
@@ -130,7 +130,7 @@ CONFIG_INSTANCE_3_LOG_CONFIG_PATH=<SERVER3_HOME_DIR>/conf/server-logs.xml
130130
----
131131
Run the edited export command.
132132

133-
Full documentation on configuring an agent is *xref:addition/index.adoc#configure[here]*.
133+
Full documentation on configuring an agent is *xref:addition/agent-installation/index.adoc[here]*.
134134

135135
=== Run agent as console application
136136

modules/ROOT/pages/installation/self-signed-certificate.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,9 @@ java -jar ./lib/server.jar ssc -n localhost \
6363
It generates a key pair and a self-signed certificate and creates `localhost.cer` and `localhost.pfx` files inside `./certificates` directory.
6464
`localhost.pfx` is assigned the password `changeit` which is provided to the command as an argument.
6565

66-
You can then use these two files to configure the server and agents for TLS encrypted communication.
66+
You can then use these two files to configure the server and agents for TLS encrypted communication.
67+
68+
[IMPORTANT]
69+
====
70+
Please note that in the rest of documentation, certificate files are referred to as `server.cer` and `server.pfx`.
71+
====

modules/ROOT/pages/installation/server.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ Although it is possible to run the NOM Server as a console application, it is no
128128
Best practice is to run the NOM Server as a service, as described in the previous section.
129129
====
130130

131+
[[unix]]
131132
=== Unix
132133
==== Passing arguments on command line
133134

@@ -200,7 +201,7 @@ java -jar .\lib\server.jar
200201

201202
[NOTE]
202203
====
203-
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]
204+
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]
204205
====
205206

206207
== Server configuration reference [[config_ref]]

0 commit comments

Comments
 (0)