foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00
Code Issues Activity

style: fix more typos in /docs/admin

Browse source
This commit is contained in:
Abdur-Rahman Mansoor 2024-05-31 16:47:58 -04:00
parent f8288ff9ff
commit f2e3723bd3
No known key found for this signature in database
GPG key ID: 8D15FCF6795779C8
5 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/admin/installation-binary.md
View file

@ -22,7 +22,7 @@ and make it executable:
Make sure `git` and `git-lfs` are installed:
`# apt install git git-lfs`
Create a user `git` on the system. Forgejo will run as that user, and when accessing git through ssh
Create a user `git` on the system. Forgejo will run as that user, and when accessing git through SSH
(which is the default), this user is part of the URL _(for example in
`git clone git@git.example.com:YourOrg/YourRepo.git` the `git` before the `@` is the user you'll create now)._
On **Debian, Ubuntu** and their derivatives that's done with:
@ -116,7 +116,7 @@ Once you're done configuring, click `Install Forgejo` and a few seconds later yo
on the dashboard (if you created an administrator account) or at the login/register screen, where you
can create an account to then get to the dashboard.
So far, so good, but we're not quite done yet - some manual configuration in the app.ini is needed.
So far, so good, but we're not quite done yet - some manual configuration in the `app.ini` is needed.
## Further configuration in Forgejo's app.ini

2
docs/admin/installation-docker.md
View file

@ -67,7 +67,7 @@ ENABLE_PUSH_CREATE_USER = true
> **NOTE:** it is not possible to use environment variables to remove an existing value, it must be done by editing the `app.ini` file.
> **NOTE:** in case you are in a selinux environment check the audit logs if you are having issues with containers.
> **NOTE:** in case you are in a SELinux environment check the audit logs if you are having issues with containers.
## Databases

2
docs/admin/moderation.md
View file

@ -7,7 +7,7 @@ Moderation tools are meant to help the Forgejo users and admins cope
with spam bots and undesirable interactions.
`[admin].SEND_NOTIFICATION_EMAIL_ON_NEW_USER` can be set to `true` on
small Fogejo instances with an open registration. Such instances are
small Forgejo instances with an open registration. Such instances are
subject to occasional spam bots registrations and saves the admin the
trouble to check on a regular basis. Read more in the [config cheat
sheet](../config-cheat-sheet/#security-security).

4
docs/admin/signing.md
View file

@ -54,7 +54,7 @@ There are three main options:
- `none` - this prevents Forgejo from signing any commits
- `default` - Forgejo will default to the key configured within `git config`
- `KEYID` - Forgejo will sign commits with the gpg key with the ID
- `KEYID` - Forgejo will sign commits with the GPG key with the ID
`KEYID`. In this case you should provide a `SIGNING_NAME` and
`SIGNING_EMAIL` to be displayed for this key.
@ -120,7 +120,7 @@ The possible options are:
- `never`: Never sign
- `pubkey`: Only sign if the user has a public key
- `twofa`: Only sign if the user logs in with two-factor authentication
- `basesigned`: Only sign if the parent commit in the base repo is signed.
- `basesigned`: Only sign if the parent commit in the base repository is signed.
- `headsigned`: Only sign if the head commit in the head branch is signed.
- `commitssigned`: Only sign if all the commits in the head branch to the merge point are signed.
- `approved`: Only sign approved merges to a protected branch.

4
docs/admin/upgrade.md
View file

@ -17,7 +17,7 @@ To be notified in advance of security releases, watch or subscribe to the RSS fe
## Semantic version compliance
Forgejo is compliant with [semantic versioning](https://semver.org/spec/v2.0.0.html) as of 7.0.0. In a nutshell it means that there is no breaking change unless the first number changes (e.g. when 8.0.0 is published it will contain breaking changes compared to 7.0.0). The release notes document those breaking changes and theey may require manual intervention depending on the Forgejo installation.
Forgejo is compliant with [semantic versioning](https://semver.org/spec/v2.0.0.html) as of 7.0.0. In a nutshell it means that there is no breaking change unless the first number changes (e.g. when 8.0.0 is published it will contain breaking changes compared to 7.0.0). The release notes document those breaking changes and they may require manual intervention depending on the Forgejo installation.
In versions prior to 7.0.0, the releases 1.19, 1.20 and 1.21 all contained breaking changes and the versioning scheme was not compliant with semantic versioning.
@ -48,7 +48,7 @@ It is **critical** to verify that Forgejo works very carefully. Restoring the ba
- Manually analyze (reading the patches to the sources of the template directory) and update the customized CSS / content.
- Do not use `forgejo help` to figure out the location of `CustomPath`, look at the configuration tab of the `Site administration` panel when logged in as an admin.
- `forgejo manager flush-queues`. If it timesout, run it again with a more generous `--timeout` argument. It is important because the queues contain serialized data that is not guaranteed to be backward compatible between versions.
- `forgejo manager flush-queues`. If it times out, run it again with a more generous `--timeout` argument. It is important because the queues contain serialized data that is not guaranteed to be backward compatible between versions.
- Go to the `Site administration` panel and pause all queues
Note: Forgejo requires [docker >= 20.10.6](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.14.0) otherwise mysterious problems will happen (mysterious in the sense that the problem will about something unrelated to the Docker version").