0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00
Commit graph

163 commits

Author SHA1 Message Date
Guiorgy
45ace87e6f removed the obsolete version element
Source: 581430f73b/content/reference/compose-file/version-and-name.md (version-top-level-element-obsolete)
2024-09-04 23:05:15 +00:00
Otto Richter
f0d90ef335 sync admin command-line docs 2024-09-04 22:59:39 +00:00
Ivan Shapovalov
0a8830c30b admin: logging-documentation: document journald support
As of forgejo/forgejo#2869, console logging implements three adaptations
for running forgejo under systemd/journald:

- forgejo learned to emit printk-style log level prefixes that are
  picked up by journald and saved as the severity level of this line
  (e.g., `<3>some text\n` means that "some text" will be saved as an
   error entry);
- forgejo learned a new pseudo-flag "journaldflags" which is supposed to
  replace "stdflags" when running under journald to reduce log clutter
  (specifically, it removes date/time from log entries since the
   time information is automatically saved by journald and displayed by
   journalctl, and replaces the textual log level by the above-described
   machine-parsable log level prefix);
- finally, forgejo will try to automatically detect whether it is
  running under journald by parsing `$JOURNAL_STREAM` environment
  variable and use "journalflags" as default flags if that is the case).

Document those.

Signed-off-by: Ivan Shapovalov <intelfx@intelfx.name>
2024-09-04 21:56:49 +00:00
Ivan Shapovalov
13be414998 admin: logging-documentation: clarify COLORIZE setting
Signed-off-by: Ivan Shapovalov <intelfx@intelfx.name>
2024-09-04 21:56:49 +00:00
Sai Nane
facf05de24 admin: Reword, format consistency
This changes terminal command blocks to always use the multiline formatting,
as the leading octothorpe looks very strange when displaying a command inline.
Two consecutive inline commands at the start was very difficult to read in the
generated html. See:
https://forgejo.org/docs/latest/admin/installation-binary/

`HTTP_PORT` has been highlighted as a code term. This also means we don't need
to worry about another underscore in the same line being added and interpreted
as syntax.

Simplifies and fixes sentence structure in a few places. I've seen arguments
for and against the use of "just" in technical writing, but I think here it's
better without?

Reworded some paragraphs so that the command comes at the end.
2024-08-28 11:08:34 +00:00
Christoph Heiss
3de284c2c9
admin: cheat-sheet: fix SCHEDULE description for extended cron tasks
Signed-off-by: Christoph Heiss <christoph@c8h4.io>
2024-08-24 17:22:18 +02:00
Alex Fu
f0374b28fe improve install binary documentation
- use useradd instead of adduser
- improve readability of systemd documentation
2024-08-15 20:48:46 +00:00
Radosław Piliszek
622c8244bd git-grep: add git.timeout.grep documentation
Code-PR: forgejo/forgejo#4931
2024-08-15 13:43:12 +02:00
Gusted
6b2a74e82c Remove pause queue step
This step can no longer be done, because this functional was removed
some releases ago.
2024-08-14 17:58:25 +00:00
TheFox0x7
1f8e663aa2
Revert "OpenTelemetry documentation (#739)"
This reverts commit 202c7aa6a7.
2024-08-08 21:04:51 +02:00
0ko
ded0ad6f85 admin: actualize LOGIN_REMEMBER_DAYS recommendation 2024-08-05 15:37:13 +00:00
matrss
faca0b8961 Fix incorrect referenced number of databases 2024-08-05 15:14:53 +00:00
TheFox0x7
202c7aa6a7 OpenTelemetry documentation (#739)
Documentation for opentelemetry feature https://codeberg.org/forgejo/forgejo/pulls/3972

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/739
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-08-05 06:05:35 +00:00
0ko
2515c7ef1f admin: update attachment.ALLOWED_TYPES with .webp 2024-08-04 21:02:44 +00:00
0ko
359d69f279 admin: sync i18n language lists with Forgejo code 2024-08-04 19:06:21 +00:00
Panagiotis "Ivory" Vasilopoulos
7cc3393317 admin: cheat sheet, improve USER_LOCATION_MAP_URL 2024-08-02 11:39:38 +02:00
Massimiliano Adamo
abbc414b1f add haproxy documentation (#781)
- add documentation to use haproxy
- add documentation to use unix socket
- add warning about NGINX binary distributions

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/781
Reviewed-by: thefox <thefox@noreply.codeberg.org>
Co-authored-by: Massimiliano Adamo <maxadamo@gmail.com>
Co-committed-by: Massimiliano Adamo <maxadamo@gmail.com>
2024-07-28 18:42:41 +00:00
senekor
cbb50df101 admin: fix typo 2024-07-26 18:12:14 +00:00
Earl Warren
5df0c12686 admin: cli: --keep-labels is a new option 2024-07-24 09:18:13 +00:00
Emmanuel BENOÎT
65f556b638 admin: more details about action runner offline registration (#769)
This PR
- adds more details regarding the nature of the secret used when registering runners offline using `forgejo-cli actions register`,
- explains how to change the secret for an existing runner ([Forgejo PR #4619](https://codeberg.org/forgejo/forgejo/pulls/4619)),
- explains how to keep the Forgejo-side command idempotent if the labels aren't known ([Forgejo PR #4610](https://codeberg.org/forgejo/forgejo/pulls/4610))

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/769
Reviewed-by: twenty-panda <twenty-panda@noreply.codeberg.org>
Co-authored-by: Emmanuel BENOÎT <tseeker@nocternity.net>
Co-committed-by: Emmanuel BENOÎT <tseeker@nocternity.net>
2024-07-24 05:41:53 +00:00
0ko
00102c44e2 admin: cheat sheet, clarify proxy configuration 2024-07-14 10:35:33 +00:00
Elias Elwyn
07db480c04 admin: expand on the redis cache adapter 2024-07-13 16:57:58 +10:00
Earl Warren
5d725ecdc3 admin: installation: docker rootless does not have USER_UID/USER_GID
The USER_UID/USER_GID are not interpretd in the rootless image, use
`user: "1024:100"` in the docker-compose example instead.

Fixes: https://codeberg.org/forgejo/docs/issues/704
2024-07-10 06:57:16 +00:00
patdyn
6eb8451336 Add link and short description for env to ini 2024-07-04 11:42:58 +00:00
Joachim Durchholz
2678e40581 reverse-proxy.md: Clearer and more admin-centric intro
- Eliminated confusing topic switch https->proxy->https.
- Moved all HTTPS mentions to end of intro.
- Added paragraph about when you'd want a reverse proxy.
- Use /code for subpath, to encourage purpose-based naming
2024-06-26 05:02:42 +00:00
Earl Warren
2d76e3a32c
admin: CLI: add F3 sub-command 2024-06-16 10:22:49 +02:00
9pfs
b362696091 Fix typo (bookwork -> bookworm) 2024-06-14 03:52:46 +00:00
Earl Warren
11859284af user: oauth2: illustrated example to add an authentication source (#703)
Preview: https://forgejo.codeberg.page/@docs_pull_703/docs/next/user/oauth2-provider/#using-a-codeberg-as-an-authentication-source
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/703
Reviewed-by: twenty-panda <twenty-panda@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-06-13 15:33:51 +00:00
Earl Warren
16834531f1
admin: storage: add missing MINIO_CHECKSUM_ALGORITHM setting
Fixes: https://codeberg.org/forgejo/forgejo/issues/4103
2024-06-11 17:37:05 +02:00
0ko
faa6814244 Fix lint & a little English improvement 2024-06-08 12:36:57 +00:00
mirko
bc38574257 Add APP_SLOGAN config 2024-06-08 14:06:12 +02:00
adagio
cd1507419f Fixes and updates installation-docker.md (#645)
Makes a minor correction to which is the next version number.

Also includes information about the `7.0` docker tag's versioning based on facts the author only can recall seeing on Matrix but currently cannot actually find direct proof of such messages existence for reference now.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/645
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-03 07:19:31 +00:00
adagio
c86099d84e
Updates whitelist to allowlist 2024-06-01 21:26:59 -04:00
adagio
a0a49c54b9 Updates installation steps (#632)
Applies standard running list sentence formatting.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/632
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-01 14:09:43 +00:00
Abdur-Rahman Mansoor
f2e3723bd3
style: fix more typos in /docs/admin 2024-05-31 16:47:58 -04:00
adagio
f8288ff9ff Updates installation.md (#631)
Adds a link to the releases management section in  `installation.md`.

Preview https://forgejo.codeberg.page/@docs_pull_631/docs/next/admin/installation/

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/631
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-05-31 13:41:56 +00:00
Abdur-Rahman Mansoor
c37e8619d6
style: fix lots of typos in installation-binary.md 2024-05-29 20:32:54 -04:00
adagio
9326746c38 Adds consistency to sentence formatting in seek-assistance.md (#633)
Places `.` symbol at the end of a couple of list sentences.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/633
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-05-28 10:47:19 +00:00
Abdur-Rahman Mansoor
d35b4548d1 style: fix typos in /docs/admin (#656)
Now that I've finished `/docs/user`  I suppose I will start working on `/docs/admin`. I didn't change all the files at once since I thought it would be annoying for the maintainers to review. If you prefer I make all the changes at once, feel free to let me know and I would be happy to do that as well. :)

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/656
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Reviewed-by: Caesar Schinas <caesar@caesarschinas.com>
Co-authored-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
Co-committed-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
2024-05-27 23:52:48 +00:00
Earl Warren
518407ccfe
admin: command-line: update
scripts/cli-docs.sh run next > docs/admin/command-line.md
2024-05-26 11:35:45 +02:00
Earl Warren
dc67b3c83a admin: installation: rootless data is in /var/lib/gitea by default
Refs: https://codeberg.org/forgejo/forgejo/issues/3869
2024-05-25 12:34:14 +00:00
adbagio
cd43c8b018 Docker installation detail fixes (#643)
Updates and fixes version descriptions for the latest Forgejo Docker image.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/643
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adbagio <h759bkyo4@mozmail.com>
Co-committed-by: adbagio <h759bkyo4@mozmail.com>
2024-05-24 07:50:39 +00:00
Earl Warren
2821d3cec4
admin: command-line: add actions-artifacts option
scripts/cli-docs.sh run next > docs/admin/command-line.md

Refs: https://codeberg.org/forgejo/forgejo/pulls/3772
2024-05-15 20:08:51 +02:00
TheFox0x7
b6b99c0b55 Add Caddy config to reverse proxy section (#605)
Added Caddy example configs, turned on syntax highlighting in nginx/apache

Closes: forgejo/website#232
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/605
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-05-14 23:07:03 +00:00
Crown0815
720667cf04 Fix incorrect default value in CheatSheet for attachment MaxSize
I tested my forgejo instance and it says that it cannot upload files larger than 2048 MB.
I also confirmed on the gitea cheatsheet where the value is also 2048 MB
(see https://docs.gitea.com/administration/config-cheat-sheet#issue-and-pull-request-attachments-attachment)
2024-05-14 10:00:38 +00:00
Kwonunn
c1b7969c1d Reverse Proxy setup guide (#600)
I've added a more comprehensive guide to set up Reverse Proxies.

So far I've added nginx configuration, I'm also planning to add apache configuration later on.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/600
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Kwonunn <kwonunnx@gmail.com>
Co-committed-by: Kwonunn <kwonunnx@gmail.com>
2024-05-10 07:22:19 +00:00
Earl Warren
359caf8476 admin(actions): the latest stable runner is 3.4.1 2024-05-10 07:19:38 +00:00
Yaroslav Halchenko
9ad5f2ab0f Add codespell support (without CI) and make it fix some typos (#536)
Per "request" of @0ko in https://codeberg.org/forgejo/forgejo/pulls/3270#issuecomment-1774032

TODOs
- postponed: how to add codespell (written in Python) to CI -- separate workflow? add to some other step? to some other tool/specification?

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/536
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-committed-by: Yaroslav Halchenko <debian@onerussian.com>
2024-05-05 14:53:04 +00:00
0ko
4cba3d36b3 Fix dead links 2024-05-05 06:18:43 +00:00
alydev
0bfc31bd0a
SSL note for minio storage, fixed dead link 2024-05-01 18:33:10 +10:00