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

183 commits

Author SHA1 Message Date
sandebert
028027fec6 Minor adjustments in the upgrade documentation (#915)
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/915
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: sandebert <sandebert@noreply.codeberg.org>
Co-committed-by: sandebert <sandebert@noreply.codeberg.org>
2024-11-07 10:20:40 +00:00
minecraftchest1
96e7886a40 Change docker install docks to refer to forgejo 9 instead of 8
Signed-off-by: minecraftchest1 <minecraftchest1@noreply.codeberg.org>
2024-11-06 01:00:29 +00:00
Earl Warren
1f260c1254
admin: runner installation: recommend docker_host: "-"
Defaulting to docker_host: "" will expose the underlying docker socket
to all containers which is a security risk. The default must be the
most secure setup.
2024-10-29 11:42:22 +01:00
Thorben Günther
385990b2c3 cheat-sheet: Improve delete_old_actions description
This matches the text in the web interface.

The old description can be easily mistaken for handling "Forgejo Actions".
2024-10-21 22:18:09 +00:00
Kwonunn
0881419f4b fix: wrong header indent 2024-10-21 14:47:06 +02:00
apoorv569
bd7373c0d8 Change internal ssh port for rootless image. (#895)
Change internal ssh port for rootless image to 2222 as the rootless image has ssh running on port 2222.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/895
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: apoorv569 <apoorv569@noreply.codeberg.org>
Co-committed-by: apoorv569 <apoorv569@noreply.codeberg.org>
2024-10-17 16:22:30 +00:00
Otto Richter
bfd9913680 admin: Initial quota docs 2024-10-15 23:15:24 +02:00
Alex Fu
c132e28383 add sh syntax highlighting to all shell code blocks 2024-10-12 06:22:48 -04:00
lynoure
c5ad84aea4 Made it a little bit easier to get the latest version of the runner and verify the file 2024-10-10 15:33:51 +00:00
Otto Richter
8f373ae546 Sort instructions for specific Forgejo/Gitea/Gogs version
... in one place instead of scattering throughout the document
2024-09-24 20:21:08 +02:00
Kwonunn
9567aff03a Improve runner installation instructions (#860)
This PR rewrites the runner installation instructions, with the following changes:

- deduplicate instructions as much as possible
- explicitly instruct to create a separate user for the runner
- reword the label explanations
- split the instructions for administrating the actions feature from the installation guide for the Forgejo Runner
- add instructions for setting up the runner as a systemd service

https://forgejo.codeberg.page/@docs_pull_860/docs/next/admin/actions
https://forgejo.codeberg.page/@docs_pull_860/docs/next/admin/runner-installation/
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/860
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Kwonunn <kwonunnx@gmail.com>
Co-committed-by: Kwonunn <kwonunnx@gmail.com>
2024-09-20 03:49:01 +00:00
0ko
ac0870ad33 admin: remove Windows-specific note (#866)
Forgejo doesn't run on Windows, so this part is just a noise.

Ref: https://codeberg.org/forgejo/forgejo/issues/712.
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/866
Reviewed-by: Otto <otto@codeberg.org>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
2024-09-19 17:03:20 +00:00
Gusted
ef75a59038 Remove CLI documentation in config cheat sheet
The configuration cheat sheet isn't the canonical documentation for the
CLI and this particular bit has no relation to `ENABLE_PPROF` setting
anymore.
Resolves forgejo/forgejo#5268
2024-09-16 11:57:52 +00:00
Otto Richter
10dff2ee1a simplify installation quickstart
Goal: prevent situations like https://codeberg.org/forgejo/forgejo/issues/5278 where users run Forgejo without reading the detailed setup guide.
2024-09-11 10:11:50 +00:00
yonas
be2d4d2c8c
Update Docker installation instructions to use v8 2024-09-07 07:42:43 -04:00
Otto Richter
182007a5a5 Update binary installation instructions 2024-09-05 13:23:31 +02:00
Otto Richter
3d46045045 Update database preparation guide
- it is related to installation instructions
- mention SQLite in the guide
- reduce the complexity of the guide (I think we don't need to cover all the details here, there are better guides available)
2024-09-05 13:23:31 +02:00
Otto Richter
a5d81cda7d Update logging section in cheat sheet
- adds journald information (also see https://codeberg.org/forgejo/docs/pulls/514)
- improves internal references
2024-09-05 08:33:25 +00:00
Joaquin Dominguez
7fd780c085 updated container file to remove timezone and localtime volume 2024-09-04 23:07:13 +00:00
Joaquin Dominguez
e2dd73e88b updated installation-docker.md file with Podman instructions 2024-09-04 23:07:13 +00:00
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