Commit graph

65 commits

Author SHA1 Message Date
Dave Anselmi
8215c254bc Move duplicate article list snippets to shortcode. (#780)
Closes #335.

This is my first attempt coding for eleventy/liquid so I'd be happy to get feedback on making the code cleaner or more idiomatic, or just more like the Codeberg style.

Co-authored-by: David Anselmi <danselmi@intecrowd.com>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/780
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2026-04-27 14:36:08 +02:00
spuzkov
d11f27378f Updated the way git signing commands are shown (#762)
### Description

This fixes #761, more specifically the part (2) of their issue post. The issue was that it was not clear that the "." at the end of the command was meant to be excluded. Even if its clear to some, accidental copy and paste with the inclusion of "." have happened. Therefore, this PR is more of an improvement to the so called "quality of life".

**The fix**

Separating the commands in to code blocks and excluding the "." from the end.

**Other additions**

- The commands are also now described.
- A new command that allows users to check their current configuration in order to verify that things are as they intended. This commands

Source for both of these additions is:  https://janik6n.net/posts/signing-git-commits-with-ssh-key/

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/762
Co-authored-by: spuzkov <spuzkov@tuta.com>
Co-committed-by: spuzkov <spuzkov@tuta.com>
2026-04-02 03:59:09 +02:00
Dependency bot
a25134a172 chore(ci): update lychee to v0.22.0, add local link checking, fix some URLs (#732)
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [lycheeverse/lychee](https://github.com/lycheeverse/lychee) | minor | `0.15.1` → `0.22.0` |

---

### Configuration

📅 **Schedule**: Branch creation - Only on Sunday and Saturday ( * * * * 0,6 ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi44Mi4wIiwidXBkYXRlZEluVmVyIjoiNDIuODIuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jeSJdfQ==-->

Co-authored-by: woodpecker-bot <woodpecker-bot@obermui.de>
Co-authored-by: Robert Wolff <mahlzahn@posteo.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/732
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org>
Co-authored-by: Dependency bot <renovate-bot@noreply.codeberg.org>
Co-committed-by: Dependency bot <renovate-bot@noreply.codeberg.org>
2026-01-16 18:40:09 +01:00
Sepperlot
29c674e528 fix: SSH repo URLs (#716)
Correct SSH URL examples to avoid confusion. Codeberg supports two different SSH URL formats with different delimiters (`:` vs `/`), but the current documentation mixes them, which can lead to misconfigurations - especially when using pattern-based Git configurations such as `includeIf "hasconfig:remote.*.url:`

There are two valid SSH URL formats when accessing Codeberg repositories:

1. SCP-like syntax (colon delimiter)
```bash
git@codeberg.org:<user>/<repo>.git
```

2. Full SSH URL syntax (slash delimiter)
```bash
ssh://git@codeberg.org/<user>/<repo>.git
```

Git treats these formats differently, so inconsistent examples in documentation can cause tools or config conditions to fail. In my case, `includeIf "hasconfig:remote.*.url:"` did not match correctly because the documented format did not reflect the proper SSH URL structure.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/716
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Sepperlot <sepperlot@noreply.codeberg.org>
Co-committed-by: Sepperlot <sepperlot@noreply.codeberg.org>
2025-12-09 15:15:02 +01:00
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
875cb34bdc Refactor and fix tables (#627)
# Changelog

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

## Changed

- Refactor tables to respect `indent_size = 1`.

## Fixed

- Tables with `<tr>` and `<td>` tags in wrong ending order.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/627
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@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-16 22:57:17 +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
pat-s
74e8925bec add spellchecker (#439)
fix #148

Adds a spell checker via `cspell` and fixes some spelling issues in the docs.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/439
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
2024-06-12 10:20:37 +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
jmarsal
bf5fe32d6a
refactor: move the command needed to a 'note' ('info') admonition box 2024-01-24 19:29:36 +01:00
jmarsal
b7f25f1431
feat: add shell command to add your GPG key to .bashrc, otherwise the signing process will not work 2024-01-23 19:32:22 +01: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
Panagiotis "Ivory" Vasilopoulos
8386857b1c Use admonition boxes more consistently
- Formatting fixes, relevant text adjustments
- Some more complicated cases (e.g. attribution), as well as outdated
  information that should be removed in a later commit were
  deliberately left unchanged.
- Some minor mistakes (speling, trailing whitespaces, punctuation)
  in the admonition boxes were also fixed.
2023-11-27 07:16:04 +01:00
Lucas Hinderberger
d55c1397f7 Replacing indented code blocks with fenced code blocks 2023-07-21 21:17:17 +02:00
f0sh
1984032bdd Add improvements to the Documentation according to open issues (#314)
Tried to close some open issues in the issue tracker by submitting the following changes as my first contribution to Codeberg:

 - added list on every section index page, should fix #63
 - added webhooks documentation, should fix #282
 - described behaviour of a limited user profile, should fix #279
 - added further explanation to 2fa section, according to Codeberg/Documentation#268, should fix #268
 - added codeberg badge generator to first-repository description, should fix #39
 - added dns record description to custom-domains, should fix #302
 - added description how to use 2fa with git, should fix #278
 - added and updated repo migration service description, should fix #312

Feedback highly appreciated.

Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/314
Co-authored-by: f0sh <f0sh@noreply.codeberg.org>
Co-committed-by: f0sh <f0sh@noreply.codeberg.org>
2023-07-08 16:27:44 +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
d5ef600ae9 Fix gpg-key.md 2022-08-06 15:44:16 +02:00
Jeremy
fecb990686 Fix ssh-fingerprint.md 2022-08-06 15:44:16 +02:00
Jeremy
196fea69f3 Fix ssh-key.md 2022-08-06 15:44:16 +02:00
Jeremy
7115b4976e Fix 2fa.md 2022-08-06 15:44:16 +02:00
n
cd12cbf78c Fix broken link 2022-03-06 00:33:49 +09: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
Otto Richter
2bda61e74d Diverse changes (#189)
a bunch of (typo) fixes, additions, rewordings

Update references

- remove mentions of the master branch, as it's removed for many repos
and might change in the future for others (fixes some dead links)
- remove mentions of moved repos with our official examples
- some on-the-fly additions or rewordings

Close #186 foobar->examples

Co-authored-by: fnetx <git@fralix.ovh>
Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/189
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>
2022-01-21 11:36:38 +01:00
n
3e9d9b87a8 Reorder articles in the security section 2021-11-21 20:13:59 +09:00
reynir
70db4885ed Add "(ssh fingerprints)" to title (#179)
Makes it easier to find the ssh fingerprints from the title alone.

Co-authored-by: Reynir Björnsson <reynir@reynir.dk>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/179
Co-authored-by: reynir <reynir@noreply.codeberg.org>
Co-committed-by: reynir <reynir@noreply.codeberg.org>
2021-11-20 14:01:24 +01: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
n
170914185d Add anchor links to headings (#159)
This PR adds anchor links to any markdown headings. It also replaces any hacky workarounds used previously.

Closes #83.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/159
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-09 11:59:36 +02:00
n
d503814095 Add halfmoon class to all content titles 2021-07-27 02:08:30 +09:00
n
1c7e459bd0 Make 'GPG key' article key unique 2021-07-22 22:32:00 +09:00
René W
a717ed6fe7 Merge branch 'master' into issue-129 2021-06-16 19:11:10 +02:00
qwerty287
0c4d6e0e09 Fix typos 2021-06-15 17:16:38 +02:00
n
5ea6b723e8 Unify SSH and HTTP clone & commit articles (#129) 2021-06-15 19:21:47 +09:00
William Davis
acd7bd1ace
Document GPG key usage (#127)
Cpaitalize Git, Linux, and change protocol to standard
    Moved attribution to file, resovled comments
    Added recommended bits and time
    Syntax error
    Did some TODOs
    Finished last section
    Finished Adding your GPG key to Codeberg
    Please fix the error
    Fix link
    Added info about some parts being derived from github's docs
    Finished Generating a GPG key
    Finished the Generating a GPG key section
    updated gpg-key.md
    Created the gpg key page

Co-authored-by: William Davis <unbeatable-101@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/127
2021-06-07 22:06:55 +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