0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-29 23:20:38 -05:00
Commit graph

32 commits

Author SHA1 Message Date
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
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
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
9pfs
b362696091 Fix typo (bookwork -> bookworm) 2024-06-14 03:52:46 +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
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
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
Christian Drexler
798fee5b11 small update to docker compose (quoted boolean, compose as module) (again) (#525)
Hi,
somehow I made a hash of the last PR #522 so it failed linting again. I hope it is ok now. Sorry for the noise!

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/525
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Christian Drexler <xunzi@noreply.codeberg.org>
Co-committed-by: Christian Drexler <xunzi@noreply.codeberg.org>
2024-04-14 12:31:01 +00:00
Rik Huijzer
05f8dd4b77 admin: clarify the Runner label keyword (#475)
It was quite painful yesterday to try to figure out why my workflow didn't work anymore after the Forgejo migration. Turns out that `gitea/act_runner` used a different default Docker image. With this PR, it should be clearer to other people what is the meaning of the labels.

Co-authored-by: Rik Huijzer <github@huijzer.xyz>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/475
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Rik Huijzer <rikh@noreply.codeberg.org>
Co-committed-by: Rik Huijzer <rikh@noreply.codeberg.org>
2024-03-10 06:29:20 +00:00
Rik Huijzer
4ff026d3ed admin: add a Docker Compose runner example (#474)
This PR extends the examples that were provided by @earl-warren in https://codeberg.org/forgejo/runner. I've tested this configuration twice today on two completely separate servers. For more information about the whole process that I've used, see https://huijzer.xyz/posts/forgejo-setup/.

I'll try to extract upstream a bit more information to the Forgejo docs. Feel free to take anything from my blog that seems useful and don't worry about credits. Feel free to copy whatever seems useful.

Co-authored-by: Rik Huijzer <github@huijzer.xyz>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/474
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Rik Huijzer <rikh@noreply.codeberg.org>
Co-committed-by: Rik Huijzer <rikh@noreply.codeberg.org>
2024-03-09 03:50:55 +00:00
Earl Warren
cc4162ecb8
admin: actions: 3.3.0 is now the default 2023-12-27 18:43:10 +01:00
Earl Warren
b311e9f8c4 admin: actions: s/forgejo-runners/myrunner/ 2023-12-18 11:50:14 +00:00
teutat3s
1886c54138 admin: actions: br-+ should be a trusted interfaces
in the NixOS firewall for actions cache to work with docker runners
2023-12-14 10:39:05 +00:00
s3lph
ac62015231 {user,admin}: actions: IPv6-capable Forgejo Runner
Preview

* Admin https://forgejo.codeberg.page/@docs_pull_243/docs/v1.21/admin/actions/
* User https://forgejo.codeberg.page/@docs_pull_243/docs/v1.21/user/actions/#execution-of-the-workflows

---

Forgejo runner receives IPv6 support in https://code.forgejo.org/forgejo/runner/pulls/120. I was requested in https://code.forgejo.org/forgejo/runner/issues/119#issuecomment-3289 to provide documentation for this feature.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/243
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: s3lph <codeberg@s3lph.me>
Co-committed-by: s3lph <codeberg@s3lph.me>
2023-12-04 17:42:08 +00:00
Earl Warren
0cca0479ee
admin: actions: the default runner is 3.2.0 now 2023-11-24 16:21:39 +01:00
Earl Warren
64d49d6bb2 admin: actions: LXC configuration 2023-11-13 18:46:23 +00:00
Earl Warren
9c0d4b25e5
{admin,user}: actions: runner 3.1+ support lxc + self-hosted
The upcoming 3.1 release of the Forgeo runner will allow to specify
which template and release must be must be used for a LXC
container. It also defines the lxc:// scheme as distinct from the
host:// scheme.

The host:// scheme is documented to be used for running jobs directly
from the host, which was not possible with the Forgejo runner versions
prior to 3.1
2023-11-09 13:01:11 +01:00
Earl Warren
142d8a03d1
admins: actions: one token can register multiple runners
See 9b698362a3

Also remove the token line from the .runner file. It is confusing and
difficult to explain because it is different from the registration
token. It really is a shared secret between the runner and the Forgejo
instance that has a purpose which is entirely different.
2023-10-07 17:17:26 +02:00
Earl Warren
f543af1e87
{admin,user}: actions: update log & artifact storage & usage 2023-09-30 00:46:03 +02:00
Earl Warren
9f8c592699 admin: actions: labels can be updated by the runner when it connects 2023-09-28 16:37:06 +00:00
Earl Warren
b71f102e9c admin: actions: enabled by default 2023-09-28 14:05:19 +00:00
Earl Warren
2cc8fba302
admin: actions: move misplaced nixos section 2023-09-28 15:53:54 +02:00
crystal
18938804e6
Fix admin runner management URI 2023-09-19 22:24:31 -06:00
Caesar Schinas
c64d2ccd06
move images to content dir and use relative paths
This is necessary for the website upgrade to Astro v3, which has a new built-in image API.
2023-08-31 23:07:42 +01:00
Earl Warren
ac639fae68
admin: actions: update the runner download name
The name scheme changed with version 3.0.0
2023-08-28 12:27:29 +02:00
Earl Warren
ace3c8f8e9 address caesar comments 2023-08-27 06:06:03 +00:00
Earl Warren
86df6f07b2 typo 2023-08-27 06:06:03 +00:00
Earl Warren
705958fcfa address gusted comments 2023-08-27 06:06:03 +00:00
Earl Warren
d1f42e1b83 admin: actions: rework and introduce OCI images 2023-08-27 06:06:03 +00:00
Earl Warren
a68070a894
admin: actions: add a section about alternative runners 2023-08-25 10:18:29 +02:00
Caesar Schinas
27864fec2b
move docs to subfolder 2023-08-15 00:19:15 +01:00
Renamed from admin/actions.md (Browse further)