0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-25 22:40:42 -05:00
Commit graph

68 commits

Author SHA1 Message Date
Earl Warren
cb05660c81
admin: CLI: generate from --help
because the output of `forgejo docs` is unusable
2023-12-31 17:02:46 +01:00
Gergely Nagy
5958b3a618
admin: database: Suggest a better collation for MySQL
In `admin/database-preparation` suggest `utf8mb4_bin` as the collate
function, rather than `utf8mb4_unicode_ci`. The former is accent- and
case sensitive, while the latter isn't, and Forgejo assumes that columns
are case sensitive.

Also add a short paragraph explaining why `utf8mb4_bin` is
suggested (case sensitivity), and what problems may arise and why if
case insensitive collation is used.

This partially addresses forgejo/forgejo#2039.

Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
2023-12-28 11:46:34 +01:00
Earl Warren
cc4162ecb8
admin: actions: 3.3.0 is now the default 2023-12-27 18:43:10 +01:00
Popolon
a58c11744a typo in systemctl 2023-12-24 22:42:12 +00:00
Paul Sargent
96f4c063f1 Arch Linux migration process (#298)
Add a description of the steps necessary to migrate a Gitea installation to Forgejo on Arch Linux using the native packages.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/298
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Paul Sargent <psarge@gmail.com>
Co-committed-by: Paul Sargent <psarge@gmail.com>
2023-12-18 15:14:55 +00: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
Earl Warren
54a3207eb3
admin: search-engines: be precise about where to find CustomPath 2023-12-08 20:31:28 +01:00
Earl Warren
0ed1f6d471 admin: SEND_NOTIFICATION_EMAIL_ON_NEW_USER needs ENABLE_NOTIFY_MAIL 2023-12-06 21:34:30 +00:00
Earl Warren
79266be552
admin: email: proofread and add links 2023-12-06 17:50:13 +01:00
Otto Richter
397b83a88c Correct default license list
Actually match the file names in option/license.
Also see https://codeberg.org/forgejo/forgejo/pulls/1888
2023-12-05 22:06:43 +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
oliverpool
b5cdc78e0c admin: release life cycle 2023-11-30 16:00:29 +01:00
Silejonu
a484c04428 fix typo 2023-11-28 10:00:25 +00:00
Earl Warren
536b6e10e0
admin: upgrade: update the latest patch release versions 2023-11-25 15:20:48 +01:00
Earl Warren
0cca0479ee
admin: actions: the default runner is 3.2.0 now 2023-11-24 16:21:39 +01:00
Earl Warren
be5b8993c9
{user,admin}: oauth2-provider: pre-registered OAuth applications 2023-11-19 18:21:41 +01:00
Earl Warren
9b2b4fc4f4 {admin,developer}/customization: add user interface customization (#244)
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/244
Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2023-11-15 21:23:43 +00:00
Earl Warren
4596970531
admin: config: USE_PROXY_PROTOCOL is not working 2023-11-13 22:40:13 +01:00
Earl Warren
ef0292cb1d admin: installation: selinux troubleshooting hint
https://matrix.to/#/!zpNKWqkiEOyljSMQDK:matrix.org/$R6rXeGdgUoRiEG2XrligRgg3YW5a8H0zf7xwBgqrvec?via=exozy.me&via=matrix.org&via=aria-net.org
2023-11-13 19:08:00 +00: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
Gusted
c8d40af3e2
Use handlebars syntax highlight for Go templates
- [Shiki](https://github.com/shikijs/shiki) doesn't support highlighting
Go templates, so instead use handlebars template highlighting for this
code snippet.
2023-11-02 22:32:33 +01:00
Earl Warren
ee97d72ee4 admin: upgrade: docker --all is docker check --all
check is the default command but the flags are handled differently
since the urfave/v2 refactor
2023-10-24 11:10:52 +00:00
Earl Warren
64ba97d470 clarify the installation instructions
-  split the installation page into separate pages for Docker, binary install, and packages
-  clarify the next step is the installation page via the web
-  clarify the first user created has admin rights
-  clarify how values in the config sheet are provided when using Docker installation
-  explain database preparation can be skipped if using SQLite which is built-in

Fixes: https://codeberg.org/forgejo/docs/issues/117
2023-10-22 10:30:40 +00:00
Earl Warren
560c50495e
admin: installation: remote data folder rewording 2023-10-15 14:45:58 +02:00
dbischof90
cabb9fca11 admin: installation: remote data folder (#193)
Documentation proposal for remote data mounting, following up from https://codeberg.org/forgejo/forgejo/issues/1590

Co-authored-by: Daniel Bischof <daniel.bischof@protonmail.com>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/193
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: dbischof90 <dbischof90@noreply.codeberg.org>
Co-committed-by: dbischof90 <dbischof90@noreply.codeberg.org>
2023-10-14 17:42:40 +00:00
Earl Warren
26ce6aa32b admin: adopt 2023-10-09 14:43:08 +00:00
Earl Warren
0b81e66c45 sync with Gitea abe8fe352711601fbcd24bf4505f7e0b81a93c5d
git diff bd4c7ce578956d9839309b16753bd5505b63b2e3..abe8fe352711601fbcd24bf4505f7e0b81a93c5d -- $(find . -type f -name '*en-us*')
2023-10-08 15:21:44 +00: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
Loïc Dachary
a0b72f9d49 admin: upgrade
Downgrade is never supported, there is no need to include details in
the documentation about the database versions.
2023-10-06 06:32:14 +00: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
Earl Warren
a527b6fd23
user: config-cheat-sheet: updates from Gitea 2023-09-22 20:00:16 +02:00
Earl Warren
b77359bfb1
sync with the latest changes from Gitea
git log --patch faa28b5a44912f1c63afddab9396bae9e6fe061c..8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd . ':(glob)docs/**/*.en-us.md'
2023-09-22 19:20:11 +02:00
Earl Warren
9056bcfc37
admin: new section on user moderation
Also
s/NOTIFY_NEW_SIGN_UPS/SEND_NOTIFICATION_EMAIL_ON_NEW_USER/
See https://codeberg.org/forgejo/forgejo/pulls/1481
2023-09-22 17:04:58 +02:00
Caesar Schinas
5d167821dc generate CLI docs from forgejo docs with a perl script 2023-09-22 14:37:01 +00:00
Octol1ttle
5f017fbf77 Add a note about keychain storage location quirks
Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com>
2023-09-20 05:14:52 +00:00
crystal
18938804e6
Fix admin runner management URI 2023-09-19 22:24:31 -06:00
Earl Warren
5cb08022ad admin: signing: adapt for Forgejo (#130)
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/130
Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2023-09-18 12:48:55 +00:00
Richard Rahl
3e3ddf4bd0
fix docker-compose files to actually make the installation persistent 2023-09-05 21:12:28 +02:00
Aravinth Manivannan
e18635359b
feat: document admin.NOTIFY_NEW_SIGN_UPS in configuration cheat sheet 2023-09-04 16:08:39 +05:30
Caesar Schinas
ca28203c54
admin:database-preparation: use different password from username in examples 2023-09-02 23:20:28 +01: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
852b447f91
admin: storage: updates and improve S3
The original documentation was written with a focus on local storage
and missed a few important aspects of how storage types can be mixed
together in some subsystems.

* unify the susbsystem paths to be "directory" instead of using "base
  path". It is not technically a directory in S3 but looks like one
  and the approximation is unlikely to cause confusion.
* use S3 instead of minio where possible to emphasize the storage type
  is not MinIO specific and add a section for the compatibility with
  garage
* change the document structure to have two separate parts:
  * [storage] the global sections
  * [xxxx] the subsystem specific section
  and within each of them local and S3 are documented separately
  because they share nothing
* [storage] is documented to be a fallback if [xxxx] does not exist
  for a given subsystem. There is no notion of inheritance because
  it behaves in ways that are not tested and for which consistency is
  not guaranteed
* backward compatibility with Gitea is documented to be the reason why
  there are no safeguards against undocumented features
2023-08-31 12:35:32 +02:00
Earl Warren
a8736608ba
admin: installation: address caesar comments
https://codeberg.org/forgejo/docs/pulls/92#issuecomment-1091839
2023-08-30 15:27:51 +02:00
firefly-cpp
12cf38145e admin:installation:Installation from package docs 2023-08-30 13:08:15 +02: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