erik/converge
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

about page vvarious fixes, typo's etc.

Browse Source
This commit is contained in:
Erik Brakkee 2024-08-16 08:33:32 +02:00
parent b48376e1c8
commit 9634cd29f2
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
pkg/server/templates/about.templ
View File

@ -29,12 +29,12 @@ templ About() {
<ul> <ul>
<li>The agent connects to converge server and specifies an id, the so-called rendez-vous id, <li>The agent connects to converge server and specifies an id, the so-called rendez-vous id,
identifying the agent. identifying the agent.
The agent outputs ane example command that can be used to connect to this agent. The agent outputs an example command that can be used to connect to this agent.
</li> </li>
<li>The agent sets up multiplexing of connections together with converge server <li>The agent sets up multiplexing of connections together with converge server
which allows it to listen on incoming connections. which allows it to listen on incoming connections.
</li> </li>
<li>This is used by the agent for running an embedded SSH server nad listening for <li>This is used by the agent for running an embedded SSH server that is listening for
incoming connection requests from clients. incoming connection requests from clients.
</li> </li>
<li>The client/user connects to the converge server using the command specified by the agent. <li>The client/user connects to the converge server using the command specified by the agent.
@ -45,9 +45,9 @@ templ About() {
</li> </li>
<li>The embedded SSH server now performs authentication, after successful login, <li>The embedded SSH server now performs authentication, after successful login,
a shell is spawned and the session is established. The shell can be any linux a shell is spawned and the session is established. The shell can be any linux
shell but also command prommpt and powershell are possible. shell but also command prompt and powershell are possible.
The connection is practically identical to a regular terminal connection. To The connection is practically identical to a regular terminal connection. To
achieve this some magic is used to make the shell beiieve it is connected to a achieve this, the shell is made to beiieve that it is connected to a
terminal. terminal.
</li> </li>
</ul> </ul>
@ -70,7 +70,7 @@ templ About() {
data between client and agent. data between client and agent.
</p> </p>
<p>Using authorized keys is a secure way of connectiong. When running the agent, the authorized keys <p>Using authorized keys is a secure way of connecting. When running the agent, the authorized keys
must be put in a file, allowing only the designated users to connect. The file containing authorized keys must be put in a file, allowing only the designated users to connect. The file containing authorized keys
can also be edited during a session with the agent, allowing more people to be added when required without can also be edited during a session with the agent, allowing more people to be added when required without
having to start over again. having to start over again.
@ -99,7 +99,8 @@ templ About() {
<h2>SSH and SFTP</h2> <h2>SSH and SFTP</h2>
<p> <p>
Both ssh and sftp are supported. Multiple shells are also allowed. Both ssh and sftp are supported. Multiple concurrent sessions to same agent are allowed as well
as multiple agents are also allowed.
</p> </p>
<h2>Timeouts</h2> <h2>Timeouts</h2>
@ -108,7 +109,7 @@ templ About() {
There is a timeout mechanism in the agent such that jobs do not hang indefinitely There is a timeout mechanism in the agent such that jobs do not hang indefinitely
waiting for a connection. This mechanism is useful to make sure build agents do not keep waiting for a connection. This mechanism is useful to make sure build agents do not keep
build agents occupied for a long time. By default, the agent exits with status 0 when build agents occupied for a long time. By default, the agent exits with status 0 when
the first client exits after logging in. The timeout is an inactivity timeout. Activity is the last client exits after logging in. The timeout is an inactivity timeout. Activity is
detected as follows: detected as follows:
<ul> <ul>
<li><b>ssh</b>: any key press is considered activity</li> <li><b>ssh</b>: any key press is considered activity</li>
@ -179,9 +180,9 @@ templ About() {
client and server are always up to date and can be downloaded in any continuous integration client and server are always up to date and can be downloaded in any continuous integration
job without having to package the required executables in an ad-hoc way. job without having to package the required executables in an ad-hoc way.
In addition a protocol version check is done. </li> In addition a protocol version check is done. </li>
<li>User-friendly error messages can be given to users in most case when things do not work <li>User-friendly error messages can be given to users in most cases when things do not work
out because of <code>wsproxy</code>, an SSH proxy command that also talk to the server out because of <code>wsproxy</code>. This is an SSH proxy command that communicates with converge
to tell the user if a connection is accepted and if not why not. </li> and provides additional information to the user. </li>
<li>A live screen showing the current sessions that are running. The sessions webpage provides <li>A live screen showing the current sessions that are running. The sessions webpage provides
additional feedback about the running sessions. </li> additional feedback about the running sessions. </li>
<li>Interactivity in the user's session with notifications about timeouts and a very <li>Interactivity in the user's session with notifications about timeouts and a very