diff options
author | James Ennis <james.ennis@codethink.com> | 2018-10-25 12:44:20 +0100 |
---|---|---|
committer | James Ennis <james.ennis@codethink.com> | 2018-10-25 13:05:43 +0000 |
commit | cf4741ceca201efa827c9bfcebba5fc2e015a7a5 (patch) | |
tree | f41b220b0fea4da357d06c1955f4c23b7daf33c6 /doc | |
parent | 2d012a2100e31843d72a9f3e4fbf54638fecb09d (diff) | |
download | buildstream-cf4741ceca201efa827c9bfcebba5fc2e015a7a5.tar.gz |
docs: Add helpful notes to artifact server configuration instructions
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/using_configuring_artifact_server.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/source/using_configuring_artifact_server.rst b/doc/source/using_configuring_artifact_server.rst index b25b5aecf..97f92fa02 100644 --- a/doc/source/using_configuring_artifact_server.rst +++ b/doc/source/using_configuring_artifact_server.rst @@ -110,6 +110,15 @@ You can also use a key pair obtained from a trusted certificate authority instea openssl req -new -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -batch -subj "/CN=artifacts.com" -out server.crt -keyout server.key +.. note:: + + Note that in the ``-subj "/CN=<foo>"`` argument, ``/CN`` is the *certificate common name*, + and as such ``<foo>`` should be the public hostname of the server. IP addresses will + **not** provide you with working authentication. + + In addition to this, ensure that the host server is recognised by the client. + You may need to add the line: ``<ip address>`` ``<hostname>`` to + your ``/etc/hosts`` file. Authenticating users ~~~~~~~~~~~~~~~~~~~~ @@ -233,3 +242,8 @@ Pull and push: client-cert: client.crt push: true + +.. note:: + + Equivalent statements can be delcared in a project's configuration file + (the ``project.conf``). |