Skip to content
Snippets Groups Projects

Add instructions on setting up GitLab SSH to README

Merged Robert Rosca requested to merge feat/readme-ssh-key-instructions into master
1 unresolved thread

After moving to use SSH remote URLs in the requirements Karim pointed out that it's possible that detector scientists and others may not have SSH keys set up yet, so it'd be useful to have a small section on this in the readme.

Description

Adds a section to the appendix describing how to set up SSH keys for EuXFEL GitLab access.

How Has This Been Tested?

N/A

Relevant Documents (optional)

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Reviewers

@ahmedk @danilevc @hammerd

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • @calibration got bored of having to @ everybody individually, and already discussed this a bit with Cyril/Philipp, so I made a calibration group.

    Even if we don't end up migrating our repositories to it, it makes it easier to ping everybody for issues/prs/whatever discussions are relevant to all of us.

272 into a separate directory to make management of keys easier if you already
273 have multiple ones
274 3. Add the public key (``id_ed25519.pub``) to your account on GitLab: https://git.xfel.eu/gitlab/profile/keys
275 4. Add the following to your ``~/.ssh/config`` file
276
277 .. code::
278
279 # Special flags for gitlab over SSH
280 Host git.xfel.eu
281 User git
282 Port 10022
283 ForwardX11 no
284 IdentityFile ~/.ssh/gitlab/id_ed25519
285
286 Once this is done you can clone repositories you have access to from GitLab
287 without having to enter your password each time. As ``pycalibration``
  • Do default settings for Maxwell include an ssh-agent setup? Not that that is necessarily relevant here, but it would be part of "without having to enter your password each time", right?

  • Good point, it's available but not set up, I'll add a note on that now. Thanks!

  • Please register or sign in to reply
  • Robert Rosca added 1 commit

    added 1 commit

    Compare with previous version

  • Thank you @roscar, LGTM

  • Robert Rosca added 1 commit

    added 1 commit

    Compare with previous version

  • Robert Rosca added 1 commit

    added 1 commit

    Compare with previous version

  • LGTM by the way :smiley:

  • Robert Rosca mentioned in commit faeedb7f

    mentioned in commit faeedb7f

  • merged

  • Please register or sign in to reply
    Loading