Skip to content

Certificate file names and minor fixes (#124) #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2023
Merged

Certificate file names and minor fixes (#124) #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions modules/ROOT/pages/first-look/linux-first-look.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<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=<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.
Expand All @@ -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]
Expand All @@ -107,7 +107,7 @@ Edit the export command below as follows:
----
export \
<OUTPUT_FROM_REGISTER_AGENT>
CONFIG_TLS_TRUSTED_CERTS=<SERVER_INSTALL_DIR>/certificates/localhost.cer \
CONFIG_TLS_TRUSTED_CERTS=<SERVER_INSTALL_DIR>/certificates/server.cer \
CONFIG_LOG_LEVEL=debug \
CONFIG_INSTANCE_1_NAME=server1 \
CONFIG_INSTANCE_1_BOLT_URI=<SERVER_1_BOLT_URI> \
Expand All @@ -130,7 +130,7 @@ CONFIG_INSTANCE_3_LOG_CONFIG_PATH=<SERVER3_HOME_DIR>/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

Expand Down
7 changes: 6 additions & 1 deletion modules/ROOT/pages/installation/self-signed-certificate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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`.
====
3 changes: 2 additions & 1 deletion modules/ROOT/pages/installation/server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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]]
Expand Down