0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-28 18:42:51 -05:00
Commit graph

757 commits

Author SHA1 Message Date
Oto Šťáva
e936cf9bfb 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_.

(cherry picked from commit 681f3a8369)
2024-11-22 10:06:06 +00:00
dcz_pf
8be347ebde Clarify API token usage (#939)
The config section can be easily missed when someone intends to only use the token as an env var. But that section contains the crucial bit of information about formatting the token.
This splits the credentials info from configuration description and makes the format explicit. While at it, the necessary permission is highlighted.

This should fix Codeberg/Community#1701

Co-authored-by: Earl Warren <earl-warren@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/939
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: dcz_pf <cobepfac.dcz@porcupinefactory.org>
Co-committed-by: dcz_pf <cobepfac.dcz@porcupinefactory.org>
(cherry picked from commit 2bb8cbc603)
2024-11-21 18:28:32 +00:00
cascading-pr
dbbe5de8ec cascading-pr update 2024-11-21 07:48:08 +00:00
Robert Wolff
278404e89d 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>
(cherry picked from commit 5fbb96de9f)
2024-11-19 10:15:07 +00:00
Earl Warren
9be7396abb admin: verify the relase schedule was updated
(cherry picked from commit e17e5f394f)
2024-11-18 06:30:34 +00:00
Earl Warren
105e3b9722 admin: link release schedule from the index
(cherry picked from commit 5425901b83)
2024-11-17 22:15:25 +00:00
Earl Warren
26bc0dcf2f admin: release schedule in JSON and markdown
(cherry picked from commit 291747bcfb)
2024-11-17 22:03:06 +00:00
julianfoad
16969d65fd docs: api-usage: tokens need 'scopes'
Document the "scopes" field that is now required when generating API tokens. Refer to the documentation of scope names.

Signed-off-by: julianfoad <julian@foad.me.uk>
(cherry picked from commit 953989cd7e)
2024-11-14 17:59:41 +00:00
billynoah
55a5065b7a 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>
(cherry picked from commit d673efa640)
2024-11-10 20:57:49 +00:00
cascading-pr
51fbc5959e cascading-pr update 2024-11-10 12:23:10 +00:00
sandebert
6094cb7c08 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>
(cherry picked from commit 028027fec6)
2024-11-07 10:21:13 +00:00
minecraftchest1
6a227d8698 Change docker install docks to refer to forgejo 9 instead of 8
Signed-off-by: minecraftchest1 <minecraftchest1@noreply.codeberg.org>
(cherry picked from commit 96e7886a40)
2024-11-06 08:02:56 +00:00
Earl Warren
618d0178c2 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.

(cherry picked from commit 1f260c1254)
2024-10-29 11:31:48 +00:00
Kwonunn
1191e379fb fix: wrong header indent
(cherry picked from commit 0881419f4b)
2024-10-21 13:00:11 +00:00
marcus doescher
cb7f49a0c8 change required go version to 1.23 (#897)
Hi, I just encountered this small issue when trying to build forgejo.
I could update this in other places as well if needed, but for now I assumed the `next` branch would be a good start.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/897
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: marcus doescher <deh.marcus@posteo.net>
Co-committed-by: marcus doescher <deh.marcus@posteo.net>
(cherry picked from commit eb58d4d121)
2024-10-17 17:39:53 +00:00
apoorv569
142d8f3018 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>
(cherry picked from commit bd7373c0d8)
2024-10-17 16:22:43 +00:00
Earl Warren
63ecf366ce contributor: release schedule for v9.0 and v10.0
v9.0 is compatible with Gitea v1.22 because Gitea v1.23 branch is not
cut yet and it won't be released in the next few days.

(cherry picked from commit 6eb5c6fbf3)
2024-10-16 14:36:14 +00:00
Otto Richter
6f7b0223fe admin: Initial quota docs
(cherry picked from commit bfd9913680)
2024-10-16 03:13:24 +00:00
Alex Fu
09e776e418 add sh syntax highlighting to all shell code blocks
(cherry picked from commit c132e28383)
2024-10-12 13:50:38 +00:00
lynoure
09a1b2a377 Made it a little bit easier to get the latest version of the runner and verify the file
(cherry picked from commit c5ad84aea4)
2024-10-11 02:01:12 +00:00
Ainsley Ellis
26d0efb6d0 Fix broken links
(cherry picked from commit 8418b8bd50)
2024-10-03 06:30:28 +00:00
ExplodingDragon
6c999985e0 supprt arch delete by arch
(cherry picked from commit 577e8791c3)
2024-09-27 08:08:10 +00:00
Earl Warren
b16bc2b2b2
update the title of the v9.0 documentation 2024-09-25 11:59:54 +02: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
d88ef00889 Fix copying mistake 2024-09-23 07:58:10 +00: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
Earl Warren
f58b896f32 contributor: infrastructure: move to a dedicated repository
The https://code.forgejo.org/infrastructure organization was created
recently to host infrastructure resources. The documentation should go there
instead of the Forgejo documentation.
2024-09-17 06:02:23 +00:00
Earl Warren
1a72849b87 user: OAuth2 section title typo 2024-09-16 11:58:33 +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
Daniel Mowitz
4bf0ad1856 Removed a line of configuration that turned out to be redundant. 2024-09-14 19:09:22 +00:00
Daniel Mowitz
e11f4a3f88 Added a link to a blog post about the emacs go mode. 2024-09-14 19:09:22 +00:00
Daniel Mowitz
9c6b25dbf3 Added documentation for Emacs as a development environment. 2024-09-14 19:09:22 +00:00
Earl Warren
8fdbb80b11 contributor: infrastructure: forward ssh with nginx instead of nft
It simplifies the setup instructions and the skill requirements for
devops to use nginx to forward all ports instead of a mix of nftables
& nginx.

Also supports IPv6 and not just IPv4.
2024-09-11 12:08:19 +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
0ko
6f34126bee contributor: base localization: document form labels style 2024-09-10 21:59:49 +05:00
Otto Richter
f25e842fec Rework contributor test instructions with new developers in mind 2024-09-09 12:02:10 +00:00
Malte Jürgens
830595982f
Add Tags and Releases page
This has been adapted from
https://codeberg.org/Codeberg/Documentation/src/branch/main/content/git/using-tags.md,
and updated to document the changes from
https://codeberg.org/forgejo/forgejo/pulls/1445.

Co-authored-by: n <n@noreply.codeberg.org>
Co-authored-by: Gerhard Beck <gerhard.beck@elkb.de>
Co-authored-by: Jeremy <jeremytbaxter@protonmail.com>
Co-authored-by: Jeremy <jtbx@duck.com>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: William Davis <unbeatable-101@noreply.codeberg.org>
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: fnetx <git@fralix.ovh>
Co-authored-by: mutluyuz <mutluyuz@noreply.codeberg.org>
Co-authored-by: n0toose <git@n0toose.net>
2024-09-08 19:39:34 +02: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
Mai-Lapyst
000ca5ab42 Reword how custom values for the shell prop work 2024-09-04 23:05:30 +00:00
Mai-Lapyst
5d576d8b3c Document better how the shell prop in steps work 2024-09-04 23:05:30 +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