Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

short explanation why to use SSH #130

Merged
fnetX merged 5 commits from :explain_ssh into master 2021年05月29日 14:59:55 +02:00

I was unsure where to put that information, i decided to update the entry page of "Working with Git Repositories" with some additional information.

comments welcome

ssh-key.md is detected as a complete change cause i added a hint to ssh agents and changed to unix-style eol. At the moment the markdown files seem to have mixed eol style - not sure if this is intentional.

closes #94

I was unsure where to put that information, i decided to update the entry page of "Working with Git Repositories" with some additional information. comments welcome `ssh-key.md` is detected as a complete change cause i added a hint to ssh agents and changed to unix-style eol. At the moment the markdown files seem to have mixed eol style - not sure if this is intentional. closes #94
Ghost changed title from (削除) WIP: short explanation why to use SSH (削除ここまで) to short explanation why to use SSH 2021年05月28日 20:24:43 +02:00
fnetX left a comment
Copy link

Nice, thank you.

Nice, thank you.
@ -10,2 +9,3 @@
Before you are able to access git repositories via SSH you need to [add a SSH key to your account](/security/ssh-key).
> **Warning**
> **Warning**
Owner
Copy link

Just wondering: do the added spaces serve a function, e.g. a Markdown newline?

Just wondering: do the added spaces serve a function, e.g. a Markdown newline?

exactly that: markdown newline without introducing a new paragraph

exactly that: markdown newline without introducing a new paragraph
Ghost marked this conversation as resolved
content/home.md Outdated
@ -9,2 +9,3 @@
If you're new to Codeberg, consider reading the [Getting Started Guide](/getting-started).
If you're new to Codeberg, consider reading the [Getting Started Guide](/getting-started).
Owner
Copy link

I think you can completely drop this? Things are always changing and the docs are more complete than they have been when this was added ...

Edit: Talking about the three white spaces after the warning, looks like the review comment is shifted again in the conversation view 😬

I think you can completely drop this? Things are always changing and the docs are more complete than they have been when this was added ... Edit: Talking about the three white spaces after the warning, looks like the review comment is shifted again in the conversation view 😬
Ghost marked this conversation as resolved
@ -91,0 +33,4 @@
The private key part of your SSH key can be protected by a passphrase. This adds an additional layer of authentication which increases security. Be aware that this will only be helpful for certain attack scenarios and does not offer 100% protection. It is recommended to keep your private key safe and - well - private.
If you are using a passphrase-protected SSH key the use of a ssh agent is strongly encouraged for improved usability. You need to enter the passphrase only once during a session.
Owner
Copy link

Should we clarify further how to achieve this?
I could imagine someone being a bit lost here - how to set this up? Where to find help?
Don't worry if this is out-of-scope, I'm not asking for a complete how-to-use-my-PC walkthrogh, but I just thought it might be nice if we could link someplace where you can find more information? What do you think?

Should we clarify further how to achieve this? I could imagine someone being a bit lost here - how to set this up? Where to find help? Don't worry if this is out-of-scope, I'm not asking for a complete how-to-use-my-PC walkthrogh, but I just thought it might be nice if we could link someplace where you can find more information? What do you think?

@fnetX the default ssh-keygen flow i know of automatically asks for a passphrase:

$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/home/user/.ssh/id_rsa): 
Enter passphrase (empty for no passphrase): 
Enter same passphrase again:

I'll try to adjust the wording a bit to reflect this.

@fnetX the default `ssh-keygen` flow i know of automatically asks for a passphrase: ``` $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" Generating public/private rsa key pair. Enter file in which to save the key (/home/user/.ssh/id_rsa): Enter passphrase (empty for no passphrase): Enter same passphrase again: ``` I'll try to adjust the wording a bit to reflect this.
n marked this conversation as resolved
@ -7,3 +7,3 @@
---
Before you are able to use SSH for git you need to [add an SSH key to your account](/security/ssh-key).
Before you are able to access git repositories via SSH you need to [add a SSH key to your account](/security/ssh-key).
Contributor
Copy link

a SSH key --> an SSH key

`a SSH key` --> `an SSH key`
Ghost marked this conversation as resolved
@ -10,4 +10,3 @@
with Codeberg.
Please note that this is a Work in Progress.
Contributor
Copy link

Unless it's referencing the command, let's make the first letter of Git uppercase everywhere.

Unless it's referencing the command, let's make the first letter of Git uppercase everywhere.
@ -13,1 +12,4 @@
There are 3 ways to interact with a git repository hosted on Codeberg:
1. [via the SSH protocol](/git/clone-commit-via-ssh)
2. [via the HTTPS protocol](/git/clone-commit-via-http)
Contributor
Copy link

Please remove the double-spacing in between the and website.

Please remove the double-spacing in between `the` and `website`.
Ghost marked this conversation as resolved
@ -14,0 +14,4 @@
1. [via the SSH protocol](/git/clone-commit-via-ssh)
2. [via the HTTPS protocol](/git/clone-commit-via-http)
3. [Using the website](/git/clone-commit-via-web/)
Contributor
Copy link

We can link to the Install Git article here.
https://docs.codeberg.org/getting-started/install-git/

We can link to the `Install Git` article here. https://docs.codeberg.org/getting-started/install-git/
Ghost marked this conversation as resolved
@ -14,0 +16,4 @@
3. [Using the website](/git/clone-commit-via-web/)
Option 1 and 2 require a git client (CLI or GUI, your choice) installed on your local system.
Contributor
Copy link

This can be reworded to:
"We recommend using the SSH protocol to connect to Codeberg."

Also, let's link to English Wikipedia article instead.
https://en.wikipedia.org/wiki/Secure_Shell_Protocol

This can be reworded to: "We recommend using the SSH protocol to connect to Codeberg." Also, let's link to English Wikipedia article instead. https://en.wikipedia.org/wiki/Secure_Shell_Protocol
Ghost marked this conversation as resolved
Contributor
Copy link

@rwa Welcome to Codeberg! Thank you for your participation and contributions to the Docs :)

@rwa Welcome to Codeberg! Thank you for your participation and contributions to the Docs :)
Ghost requested review from n 2021年05月29日 11:01:26 +02:00
content/home.md Outdated
@ -6,4 +6,4 @@ Welcome to the Codeberg Documentation pages!
<span class="wide-only">Please choose a section from the main menu on the left.</span>
<span class="narrow-only">Please choose a section from the main menu, which you can access by clicking/touching the three stripes at the top right.</span>
If you're new to Codeberg, consider reading the [Getting Started Guide](/getting-started).
Contributor
Copy link

Please remove the WIP line instead and restore the line with the Getting Started Guide.

Please remove the WIP line instead and restore the line with the Getting Started Guide.
Ghost marked this conversation as resolved
@ -91,0 +29,4 @@
> Enter a file in which to save the key (/c/Users/you/.ssh/id_rsa):[Press enter]
```
4. You will be asked for a passphrase, enter on if you like to or leave the prompt empty.
Contributor
Copy link

enter on --> enter one

`enter on` --> `enter one`
Ghost marked this conversation as resolved
@ -91,0 +33,4 @@
The private key part of your SSH key can be protected by a passphrase. This adds an additional layer of authentication which increases security. Be aware that this will only be helpful for certain attack scenarios and does not offer 100% protection. It is recommended to keep your private key safe and - well - private.
If you are using a passphrase-protected SSH key, the use of a ssh agent is strongly encouraged for improved usability. You need to enter the passphrase only once during a session.
Contributor
Copy link

I don't think we need to mention this here, since it's explained at the end under sub-heading Avoid re-typing the passphrase.

I don't think we need to mention this here, since it's explained at the end under sub-heading `Avoid re-typing the passphrase`.
Ghost marked this conversation as resolved
@ -91,0 +77,4 @@
If this is unexpected, please log in with password and setup Gitea under another user.
```
*Note: All codeberg users share a single unix user named `git` which is used to check out repositories. Depending on the key provided, permission is granted or denied. You can check out all repositories with your key which you have permission for. You can push code to all repositories where you have write access.*
Contributor
Copy link

codeberg --> Codeberg

`codeberg` --> `Codeberg`
Ghost marked this conversation as resolved
@ -91,0 +86,4 @@
If you are working at the command line, you can alternatively do this directly:
```shell
$ eval `ssh-agent`
Contributor
Copy link

Please change eval `ssh-agent` to eval $(ssh-agent). The back-tick is generally not recommended and can be mistaken for a quote.

Please change ``` eval `ssh-agent` ``` to ``` eval $(ssh-agent) ```. The back-tick is generally [not recommended](https://mywiki.wooledge.org/BashFAQ/082) and can be mistaken for a quote.
Ghost marked this conversation as resolved
fnetX left a comment
Copy link

Since some of the cosmetic changes are already unrelated to this PR (they existed in the docs before, probably came up because the diff of the SSH article was hard to compare 😉), I think this is fine to merge.
Thank you very much for improving this, thank you for fixing the tiny stuff, too. There is this one lowercase Git still mentioned (I marked the conversation as unresolved), and then we're good to go IMO.

Since some of the cosmetic changes are already unrelated to this PR (they existed in the docs before, probably came up because the diff of the SSH article was hard to compare 😉), I think this is fine to merge. Thank you very much for improving this, thank you for fixing the tiny stuff, too. There is this one lowercase Git still mentioned (I marked the conversation as unresolved), and then we're good to go IMO.
n approved these changes 2021年05月29日 14:57:04 +02:00
Contributor
Copy link

Thanks for fixing all the little things. Sorry for making you fix unrelated parts 🙈.

Thanks for fixing all the little things. Sorry for making you fix unrelated parts 🙈.
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation!130
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch ":explain_ssh"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?