doc updates.

This commit is contained in:
Erik Brakkee 2024-07-25 21:46:52 +02:00
parent a59011b00c
commit 4804bf4cd1

View File

@ -77,10 +77,7 @@
<p>
Above, ID is a unique id for the job, the so-called rendez-cous ID. This should not conflict with IDs
used by other agents. The ID is used for a rendez-vous between the end-user on a local system and
the continuous integration job running on a build agent. When ID is specified with the
-id option, a file with ssh authorized (public) keys must be provided in the current directory
named .convergekeys. The file must consist of one key per line. If the -id option is not
specified a random ID is generated and the user must login with a username and password.
the continuous integration job running on a build agent.
The agent to the converge server and tells it the ID. Clients can now connect to the Converge
server to establish a connection to the CI job through converge by also specifying the same
@ -123,11 +120,7 @@
sftp -oServerAliveInterval=10 -oProxyCommand="wsproxy ws{{.secure}}://{{.host}}/client/ID" abc@localhost
</pre>
<p>
<code>abc</code> is a fixed user defined by converge. It has a very exciting password.
</p>
<h2>Local clients: using SSH with ZZa local TCP forwarding proxy</h2>
<h2>Local clients: using SSH with a local TCP forwarding proxy</h2>
<p>
This option is less convenient than the proxy command because it requires two separate
@ -152,8 +145,27 @@
sftp -oServerAliveInterval=10 -oPort=10000 abc@localhost
</pre>
<h2>Authentication</h2>
<p>
<code>abc</code> is a fixed user defined by converge. It has a very exciting password.
The <code>abc</code> user above is defined by the Converge server and
communicated to the agent when the agent is started.
Another way to authenticate is through an .authorized_keys file in the
same directory as where the agent is started.
This can be setup as follows before starting the agent:
</p>
<pre>
# linux
echo "ssh-rsa dkddkdkkk a@b.c" > .authorized_keys
echo "ssh-rsa adfadjfdf d@e.f" >> .authorized_keys
# windows
echo ssh-rsa dkddkdkkk a@b.c > .authorized_keys
echo ssh-rsa adfadjfdf d@e.f >> .authorized_keys
</pre>
<p>
Note that on windows you should not used quotes.
</p>
<h1 id="downloads">Downloads</h1>