0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2025-01-15 01:29:45 -05:00
Commit graph

209 commits

Author SHA1 Message Date
0ko
23443f94f5 fix(admin/cheat-sheet): actualize service.explore 2025-01-09 19:13:34 +05:00
Robert Wolff
b456b064ce specify container.options as string, fix #994 2025-01-08 12:39:43 +01:00
Christoph Heiss
a23914b548
admin: runner-installation: update container.docker_host description
The behaviour was changed in a non-backwards-compatible manner with
5.0.0 [0], and then further modified with the 5.0.3 release [1].
Mention that fact explicitly as an additional note, so that users know
how to configure it as needed based on their version.

The description in the example config is taken from upstream [2].

[0] https://code.forgejo.org/forgejo/runner/src/branch/main/RELEASE-NOTES.md#5-0-0
[1] https://code.forgejo.org/forgejo/runner/src/branch/main/RELEASE-NOTES.md#5-0-3
[2] https://code.forgejo.org/forgejo/runner/src/branch/main/internal/pkg/config/config.example.yaml

Signed-off-by: Christoph Heiss <christoph@c8h4.io>
2025-01-05 14:33:14 +01:00
Christoph Heiss
46420f31e0 tree-wide: fix typos
Signed-off-by: Christoph Heiss <christoph@c8h4.io>
2025-01-05 10:04:31 +00:00
Christoph Heiss
2bb951215c admin: runner-installation: update NixOS instructions (#998)
Preview: https://forgejo.codeberg.page/@docs_pull_998/docs/next/admin/runner-installation/#nixos

Fixes #903.

As described in that issue, the Nix package has been renamed upstream, as well as that the mentioned service module does not exist in reality.
I reworked that section to bring everything up-to-date. The mentioned labels pre-population does not apply to Forgejo, at least.  I have also added a small example as reference.

Further, I included a small change to `scripts/preview.sh`, to detect the actual URL open command - on Linux, `xdg-open` is normally the canonical one.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/998
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Christoph Heiss <christoph@c8h4.io>
Co-committed-by: Christoph Heiss <christoph@c8h4.io>
2025-01-05 09:51:32 +00:00
George Bartolomey
26583527ed Add DEFAULT_UPDATE_STYLE
Signed-off-by: George Bartolomey <george@bh4.ru>
2024-12-30 15:33:09 +00:00
Earl Warren
36defe7990
admin: command-line: update 2024-12-30 12:09:49 +00:00
0ko
3ff80d4b69 fix(runner-installation): update location of example compose file 2024-12-27 06:38:15 +00:00
Earl Warren
4700c033bf admin: upgrading from Gitea < 1.23 is a two step process 2024-12-25 17:30:02 +00:00
Christoph Heiss
b91de06d63
cheat-sheet: reword description of time.DEFAULT_UI_LOCATION option
The current description is pretty unclear on what the option actually
does (and the name isn't helpful either). Completely reword it, as well
as mentioning the default value too.

Signed-off-by: Christoph Heiss <christoph@c8h4.io>
2024-12-23 11:52:54 +01:00
SinnySupernova
8369020f6a A few minor docs edits (#973)
Co-authored-by: Sinny Supernova <sinny@avi.pw>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/973
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: SinnySupernova <sinnysupernova@noreply.codeberg.org>
Co-committed-by: SinnySupernova <sinnysupernova@noreply.codeberg.org>
2024-12-20 17:43:03 +00:00
Earl Warren
c63a884686
admin: recommend data.forgejo.org over code.forgejo.org
- for actions
- for mirrors
- for downloading
2024-12-19 11:06:44 +01:00
jagipson
11b9ffa5b8 Update docs/admin/installation-binary: add `sudo' as needed
In shell, prefixing a command with `sudo' only applies to the following command.  Just as with newlines, semicolons and pipes, the AND (`&&') and OR (`||') operators separate commands.
2024-12-18 14:10:04 +00:00
Squel
13a2d0ba70 add ENABLE_INTERNAL_SIGNIN
Ref: forgejo/forgejo#6112
2024-12-15 05:44:57 +00:00
Otto Richter
8c07407d6f Sync command-line docs 2024-12-09 09:36:33 +01:00
Otto Richter
608cf42954 Sync oauth2.INVALIDATE_REFRESH_TOKEN
>
> Default value was toggled in 89b1723d35
2024-12-09 09:16:41 +01:00
Otto Richter
f70c3a5d93 Sync config cheat sheet with LFS values
See fe5adbbbdc
and https://codeberg.org/forgejo/forgejo/pulls/6170
2024-12-06 01:09:54 +01:00
Dirk
660547d454 reflect default database in configuration cheat sheet
related to

* https://codeberg.org/forgejo/forgejo/issues/5223
* https://codeberg.org/forgejo/forgejo/pulls/5415
2024-11-29 21:59:31 +00:00
Benedikt Straub
0ddfc466c6
Add Low German to list of default languages 2024-11-25 18:36:17 +01:00
Oto Šťáva
681f3a8369
Unify Alpine versions across the repo
This mainly came about because I noticed an inconsistency in the
`docs/user/actions.md` section, where it said a snippet ensures the usage
of _Alpine 3.18_, but the snippet actually obviously said _3.19_.

While I was at it, I just updated all mentions of Alpine I could find to
the current _3.20_.
2024-11-22 10:41:08 +01:00
James Hatfield
a8c002eba7 cheat-sheet: document new setting for blocking disposable email domains 2024-11-21 18:53:45 -06:00
Robert Wolff
5fbb96de9f admin: fix release schedule EOL dates (#936)
* all future release and EOL dates on Wednesdays
* v7 with EOL 2025

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/936
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Robert Wolff <mahlzahn@posteo.de>
Co-committed-by: Robert Wolff <mahlzahn@posteo.de>
2024-11-19 10:14:53 +00:00
Earl Warren
e17e5f394f
admin: verify the relase schedule was updated 2024-11-17 23:48:03 +01:00
Earl Warren
5425901b83
admin: link release schedule from the index 2024-11-17 23:02:06 +01:00
Earl Warren
291747bcfb
admin: release schedule in JSON and markdown 2024-11-17 22:20:18 +01:00
billynoah
d673efa640 Document PREFERRED_TIMESTAMP_TENSE setting (#918)
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/918
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: billynoah <billynoah@noreply.codeberg.org>
Co-committed-by: billynoah <billynoah@noreply.codeberg.org>
2024-11-10 20:56:58 +00:00
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