Merge branch 'benbrewer/install-artifacts-doc-improvements' into 'master'

Improve documentation for artifact cache installation

See merge request BuildStream/buildstream!777

1 files changed, 8 insertions, 5 deletions

diff --git a/doc/source/install_artifacts.rst b/doc/source/install_artifacts.rst
index 38c81ed38..6bea7f548 100644
--- a/doc/source/install_artifacts.rst
+++ b/doc/source/install_artifacts.rst
@@ -161,13 +161,13 @@ Below are two examples of how to run the cache server as a systemd service, one
 
    [Service]
    Environment="LC_ALL=C.UTF-8"
-   ExecStart=/usr/local/bin/bst-artifact-server --port 11001 --server-key {{certs_path}}/privkey.pem --
-   server-cert {{certs_path}}/fullchain.pem {{artifacts_path}}
+   ExecStart=/usr/local/bin/bst-artifact-server --port 11001 --server-key {{certs_path}}/server.key --server-cert {{certs_path}}/server.crt {{artifacts_path}}
    User=artifacts
 
    [Install]
    WantedBy=multi-user.target
 
+.. code:: ini
 
    #
    # Pull/Push
@@ -178,9 +178,7 @@ Below are two examples of how to run the cache server as a systemd service, one
 
    [Service]
    Environment="LC_ALL=C.UTF-8"
-   ExecStart=/usr/local/bin/bst-artifact-server --port 11002 --server-key {{certs_path}}/privkey.pem --
-   server-cert {{certs_path}}/fullchain.pem --client-certs /home/artifacts/authorized.crt --enable-push /
-   {{artifacts_path}}
+   ExecStart=/usr/local/bin/bst-artifact-server --port 11002 --server-key {{certs_path}}/server.key --server-cert {{certs_path}}/server.crt --client-certs {{certs_path}}/authorized.crt --enable-push {{artifacts_path}}
    User=artifacts
 
    [Install]
@@ -188,11 +186,16 @@ Below are two examples of how to run the cache server as a systemd service, one
 
 Here we define when systemd should start the service, which is after the networking stack has been started, we then define how to run the cache with the desired configuration, under the artifacts user. The {{ }} are there to denote where you should change these files to point to your desired locations.
 
+For more information on systemd services see: 
+`Creating Systemd Service Files <https://www.devdungeon.com/content/creating-systemd-service-files>`_.
+
 User configuration
 ~~~~~~~~~~~~~~~~~~
 The user configuration for artifacts is documented with the rest
 of the :ref:`user configuration documentation <user_config>`.
 
+Note that for self-signed certificates, the public key fields are mandatory.
+
 Assuming you have the same setup used in this document, and that your
 host is reachable on the internet as ``artifacts.com`` (for example),
 then a user can use the following user configuration: