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

92 commits

Author SHA1 Message Date
Bao Trinh
ff3d0ddea6
admin: logging-documentation: fix inaccuracies 2024-03-21 07:47:39 -05:00
Panagiotis "Ivory" Vasilopoulos
02aa6e323b Capitalize titles of guide index pages 2024-03-17 20:50:02 +01: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
Rik Huijzer
7a66846f4a Incorporate feedback
Co-authored-by: Earl Warren <contact@earl-warren.org>
2024-03-08 07:24:05 +01:00
Rik Huijzer
1288f10550 Fix lint issue 2024-03-07 18:21:29 +01:00
Rik Huijzer
345765e21f Add rootless installation instructions 2024-03-07 17:04:47 +01:00
Gusted
3886dc485b admin: move Gitea migration to its own page
It doesn't feel right to have such guide on the installation page, it
feels more natural to have it's own page. This also keeps the
'installation' page clean, which currently feels more like an index
page, given it's linking to two other pages (installation from {binary,docker}).
2024-03-07 11:13:53 +00:00
Earl Warren
920b0e97fd
update admin & user guide with semantic versioning
* Explain how the semantic version relate to the API
* Update the admin guide terminology
* Add a legacy section in the user reference guide
2024-03-02 20:41:58 +08:00
Shiny Nematoda
6cc672040b admin: Document fallback behavior of repo indexer (#444)
ref: https://codeberg.org/forgejo/forgejo/pulls/1594

Preview: https://forgejo.codeberg.page/@docs_pull_444/docs/next/user/code-search/
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/444
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Shiny Nematoda <snematoda@noreply.codeberg.org>
Co-committed-by: Shiny Nematoda <snematoda@noreply.codeberg.org>
2024-02-29 15:06:38 +00:00
Earl Warren
24def40ad3 sync with Gitea d3982bcd814bac93e3cbce1c7eb749b17e413fbd
git diff abe8fe352711601fbcd24bf4505f7e0b81a93c5d..d3982bcd814bac93e3cbce1c7eb749b17e413fbd -- $(find . -type f -name '*en-us*')
2024-02-25 18:03:28 +00:00
Gusted
aa48cb3b99 admin: Add ambiguous character detection config
- Ref: https://codeberg.org/forgejo/forgejo/pulls/2427
2024-02-24 12:25:53 +00:00
Marko Korhonen
8bc412af4c
Fix typo 2024-02-24 11:19:09 +02:00
Gusted
162f0ad25c
admin: add new option to config cheat sheet
- Ref: https://codeberg.org/forgejo/forgejo/pulls/2418
2024-02-21 11:55:43 +01:00
Otto Richter
bd2e86a799 Drop support for Microsoft SQL Server 2024-02-18 20:51:58 +01:00
Panagiotis "Ivory" Vasilopoulos
d12a9fee60 admin/customization: No need to be a developer for custom branding (#427)
Preview: https://forgejo.codeberg.page/@docs_pull_427/docs/next/admin/customization/

---

The previous version of this document insinuated that you need to be
familiar with Forgejo's source code and compile Forgejo from source
for custom branding changes. As of the most recent Forgejo version,
this is not necessarily true, as custom files can be served from
the CustomPath.

Administrators that were not developers therefore dismissed the
other guide and its contents without reading this, and I was one
of them. I thought it would make sense for this file to provide
information on where to put a custom logo. This change does not
fix it (this will be done later), but it will reduce the confusion
for now.

This warning confused me personally and other Forgejo users, as I
had one person tell me IRL that they thought that it was not possible
to serve a custom logo.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/427
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-committed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
2024-02-18 17:22:54 +00:00
François Kooman
29d9296d14 clarify which reverse proxy configuration fields need to be under [security] 2024-02-18 15:29:33 +00:00
Earl Warren
c81c50daa4
admin: installation: v1.21 is current 2024-02-17 11:40:29 +01:00
Earl Warren
c7dbb76caa admin: cheat-cheat: [cache].HOST redis+sentinel
Fixes: https://codeberg.org/forgejo/docs/issues/380
2024-02-12 13:35:23 +00:00
Gusted
62c52bbcb8
config: Fix typo
- Ref: https://codeberg.org/forgejo/forgejo/pulls/2226
2024-01-24 16:58:40 +01:00
lennybacon
cc20e1b840 Fixed the path
The app.ini is in `/etc/forgejo`.
2024-01-23 17:23:32 +00:00
Earl Warren
808f85e05f
admin: command-line: VERSION has variance, dont use it 2024-01-23 18:09:28 +01:00
Gergely Nagy
bdc5a11431 admin: Document Badges on the cheat sheet
Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
2024-01-14 19:11:06 +01:00
Gergely Nagy
28cdb8ca82 admin: Document [repository].DOWNLOAD_OR_CLONE_METHODS
Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
2024-01-10 17:24:41 +00:00
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