Commit graph

32 commits

Author SHA1 Message Date
Javier Pérez
941914f698 Fix lint issues (#629)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Fixed

- Lint issues:
  - Line length ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  -  Heading levels should only increment by one level at a time ([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md)).
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md)).
---

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/629
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-11-21 12:35:05 +01:00
Gusted
32485acc13 chore(deps): update dependency prettier to v3.6.2 (#686)
Co-authored-by: woodpecker-bot <woodpecker-bot@obermui.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/686
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-10-20 18:58:07 +02:00
hugobuddel
cff67c76cb Use full path when specifying ssh key file (#669)
Using a `~` apparently does not work with `ssh-keygen`:
```
$ ssh-keygen -t ed25519 -a 100
Generating public/private ed25519 key pair.
Enter file in which to save the key (/home/knud/.ssh/id_ed25519): ~/.ssh/id_ed25519_codeberg
Enter passphrase for "~/.ssh/id_ed25519_codeberg" (empty for no passphrase):
Enter same passphrase again:
Saving key "~/.ssh/id_ed25519_codeberg" failed: No such file or directory
```

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/669
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: hugobuddel <hugo@buddelmeijer.nl>
Co-committed-by: hugobuddel <hugo@buddelmeijer.nl>
2025-09-06 14:00:07 +02:00
Pigeon-AFA
9b85081adf Security section: small additions (#634)
- Added Ente Auth to list of 2FA apps due to its open source/E2EE/cross platform nature
- Added links to the relevant user settings for SSH keys

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/634
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Pigeon-AFA <antifantwerp@proton.me>
Co-committed-by: Pigeon-AFA <antifantwerp@proton.me>
2025-07-01 20:59:00 +02:00
aec
71a83596f9 Add Wayland method to copy SSH key (#631)
Adds a method for using `wl-clipboard` to copy the SSH key on Wayland compositors.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/631
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: aec <aec@noreply.codeberg.org>
Co-committed-by: aec <aec@noreply.codeberg.org>
2025-06-26 00:59:27 +02:00
Javier Pérez
e405ae93ae Lint the documentation (#626)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Removed

- Disable the Markdownlint rule MD024 (`Multiple headings with the same content`).

## Fixed

- Syntax errors in `.markdownlint.yaml`.
- Markdownlint issues:
  - Heading levels should only increment by one level at a time([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md))
  - Hard tabs ([MD010](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md))
  - Reversed link syntax ([MD011](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md))
  - Dollar signs used before commands without showing output ([MD014](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md))
  - Multiple top-level headings in the same document ([MD025](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md))
  - Trailing punctuation in heading ([MD026](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md))
  - Ordered list item prefix([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md))
  - Emphasis used instead of a heading([MD036](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md))
  - Fenced code blocks should have a language specified ([MD040](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md))
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md))
  - Link text should be descriptive ([MD059](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md))

- Prettier issues.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/626
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 15:39:01 +02:00
Javier Pérez
c6ac9a9f94 Reduce line length limit and format content (#623)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Update line length limit from 500 characters to 120 characters.

## Fixed

- Most instances of these lint issues:
  1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)).
  3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)).
  4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)).

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 11:38:21 +02:00
ninthcircle
8649e50afa
fix: update instructions for adding custom key path in ssh-keygen (#535) 2025-02-22 21:17:35 +05:30
Gusted
03342e98ec feat: use Eleventy's image plugin for image transformation (#488)
Use https://www.11ty.dev/docs/plugins/image/ to transform images on build time to avif, webp and jpeg.

Images are moved to `/content/images`.

`<picture>` is no longer needed, the plugin does this automatically.

Remove webp images from the source.

Resolves #152
Resolves #368

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/488
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-29 06:12:05 +00:00
egnun
3bd7c665c7 Updated paragraph "Telling Git about your SSH key" (#470)
I don't know, if it makes a difference, but  for the "user.signingKey" option it should probably say "<PATH TO PUBLIC SSH KEY>".

The official git documenation says, that git expects a public key.
https://git-scm.com/docs/git-config#Documentation/git-config.txt-gpgsshdefaultKeyCommand

Also some other guides use the public key:
https://blog.dbrgn.ch/2021/11/16/git-ssh-signatures/
https://dev.to/ccoveille/git-the-complete-guide-to-sign-your-commits-with-an-ssh-key-35bg

So, I updated the paragraph accordingly.

Signed-off-by: egnun <egnun@mailbox.org>

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/470
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: egnun <egnun@mailbox.org>
Co-committed-by: egnun <egnun@mailbox.org>
2024-08-19 22:39:01 +00:00
crapStone
da1b77aa6a Add woodpecker ci & many linters (and their required fixes) (#377)
closes #238

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
2024-06-11 07:51:22 +00:00
Sergey Volkov
d475852dc2 Add SSH commit signing content (#420)
Add the SSH commit signing section to the SSH key management page. Git has had this feature for a while now and SSH keys are easier to manage since they can be used for both authentication and signing, so I think it makes sense to document this.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/420
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Sergey Volkov <ser121512@yandex.ru>
Co-committed-by: Sergey Volkov <ser121512@yandex.ru>
2024-05-16 13:55:48 +00:00
Alex
966404aa5c Using Security keys on Codeberg (#367)
This PR adds docs on WebAuthn usage on Codeberg. It attempts to cover:
- using WebAuthn as a 2FA option on web logins
- using FIDO2 over SSH using the OpenSSH client

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/367
Co-authored-by: Alex <alex@blueselene.com>
Co-committed-by: Alex <alex@blueselene.com>
2023-11-28 20:57:37 +00:00
NeatNit
2887826c38 Update SSH connection test text to match actual result (#307)
I just went through these steps and noticed that the message is wrong, so here's the update. Note that the message normally shows the username and key name, which I've replaced with "____".

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/307
Co-authored-by: NeatNit <neatnit@noreply.codeberg.org>
Co-committed-by: NeatNit <neatnit@noreply.codeberg.org>
2023-05-30 09:07:14 +00:00
fpare
51570538fd add the ssh url scheme 2022-11-29 17:18:29 +00:00
fpare
1e341a0845 clarify the title 2022-11-29 17:18:29 +00:00
narF
9b31a3da09 Mise à jour de 'content/security/ssh-key.md' 2022-11-29 17:18:29 +00:00
narF
7fba31ab1d add instructions to switch from https to ssh in ssh-key.md 2022-11-29 17:18:29 +00:00
eo
45473fb409 Correct SSH key misunderstanding 2022-10-21 17:10:35 +02:00
Jeremy
71e01038c5 Revise 2022-08-06 15:44:16 +02:00
Jeremy
196fea69f3 Fix ssh-key.md 2022-08-06 15:44:16 +02:00
Gusted
6b53d9cf23 Revisit GPG & SSH documentation (#206)
- Update the wording of gpg-key.md(ssh-key.md's wording is already nicely done). To be more fluent and have a better explanation.
- Add a section to verify the GPG & SSH key.
- Add step for git to sign new commits by-default.
- Resolves #177

Co-authored-by: Gusted <williamzijl7@hotmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/206
Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Co-committed-by: Gusted <gusted@noreply.codeberg.org>
2022-03-04 22:17:26 +01:00
n
3e9d9b87a8 Reorder articles in the security section 2021-11-21 20:13:59 +09:00
n
6839d4119c Improve SSH key article (#161)
This PR improves the SSH key article, removes the part where email is used as a label (newcomers might think this is mandatory and leak their email) and changes the public key type to a more secure ed25519.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/161
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-16 01:12:47 +02:00
William Davis
686bfc5978
OSX --> macOS 2021-06-06 17:51:02 -04:00
René Wagner
ef00090cd4
more cosmetic changes to ssh-key.md 2021-05-29 12:36:34 +02:00
René Wagner
09659373e7
ssh usage: cosmetic changes 2021-05-29 10:14:36 +02:00
René Wagner
e26265cf78
short explanation why to use SSH 2021-05-28 19:53:31 +02:00
René Wagner
54a921b0cd
add description for private key passphrase 2021-05-27 21:40:03 +02:00
Martijn de Boer
5d2571e988
Security; some grammar and typos 2020-10-16 16:43:55 +02:00
Lucas Hinderberger
e080c61be2 Knut-ified Screenshots / Typos / Fixes #55 2020-09-02 17:05:09 +02:00
Lucas Hinderberger
cfa9cbbbf5 Blending together codeberg-docs-prototype and original Codeberg/Documentation 2020-08-13 12:31:45 +02:00
Renamed from doc/getting-started/authentication/ssh-key.md (Browse further)