Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Update documentation for localVC SSH setup #8835

Merged
merged 9 commits into from
Jul 5, 2024
12 changes: 9 additions & 3 deletions docs/admin/setup/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,15 @@ variables (`Spring relaxed binding <https://github.com/spring-projects/spring-bo
possible for the system account that runs Artemis and administrators.


.. _configure-ssh-access:

SSH Access
----------

Follow the following steps to create and manage SSH key pairs,
To allow users to clone their programming exercises via SSH in the integrated code lifecycle setup, SSH must be
configured correctly on the server.

Follow the next steps to create and manage SSH key pairs,
distribute them across multiple nodes via Ansible, configure the
system to use these keys, and adapt Nginx to enable SSH routing.

Expand All @@ -74,11 +79,12 @@ using the ssh-keygen command. Here's how you can do it:
.. code-block:: bash

# Generate RSA key pair
ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa
ssh-keygen -t rsa -b 4096 -f ~/artemis_ssh/id_rsa

# Generate Ed25519 key pair
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519
ssh-keygen -t ed25519 -f ~/id_ed25519

Make sure the keys have the standard name for the according key type. E.g. id_rsa for RSA.

Adding Key Pairs to VM via Ansible
""""""""""""""""""""""""""""""""""
Expand Down
4 changes: 1 addition & 3 deletions docs/dev/setup/integrated-code-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,7 @@ To create a course with registered users, you can use the scripts from ``support
</iframe>

- Make sure that the result of your submission is displayed in the Artemis UI.

.. HINT::
At the moment, the Local VC system only supports accessing repositories via HTTP(S) and Basic Auth. We plan to add SSH support in the future. For now, you need to enter your Artemis credentials (username and password) when accessing template, solution, test, and assignment repositories.
- Users can access their repositories via HTTPS and SSH. For SSH to work, you must first :ref:`configure SSH <configure-ssh-access>`.

For unauthorized access, your Git client will display the respective error message:

Expand Down