summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Brewer <ben.brewer@codethink.co.uk>2018-09-04 15:41:23 +0100
committerBen Brewer <ben.brewer@codethink.co.uk>2018-09-04 15:41:23 +0100
commit9b327eb6608bd009968e80976cb77539b18a2094 (patch)
tree4649c4c71758a7f0531bd85b7653a12b1b8999b4
parent6a0cdedf0b2d5f17fcacddbb7c398d288111457f (diff)
downloadbuildstream-9b327eb6608bd009968e80976cb77539b18a2094.tar.gz
Improve documentation for artifact cache installation
Remove ambiguity about systemd service files being separate. Add URL for more information about systemd service files. Add note about public keys being mandatory for self-signed certs. Make cert/key file naming consistent throughout document.
-rw-r--r--doc/source/install_artifacts.rst13
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: