foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-22 22:17:10 -05:00
Code Issues Activity
514 commits 7 branches 0 tags 20 MiB
Commit graph

226 commits

Author SHA1 Message Date
Earl Warren
64bdcbbb48
developer: infrastructure: no trailing / in reverse proxy 2023-12-12 11:58:52 +01:00
Earl Warren
691d8890cf
developer: infrastructure: hetzner{02,03} root file system backups 
No information in the root filesystem is really worth saving as it
can be recreated from this documentation or even from scratch manually
if needs be. But it is cheap to keep that backup and it is worth the
effort if it can save a few hours of work when an accident happen.

The more sophisticated way to do it would be to setup DRBD with the
root file system. But this is not straightforward and to ensure it
won't get the admin in trouble when an accident happen is tricky. It
is the one time when every bit of complication can quickly become a
blocker or an unecessary burden.
 2023-12-11 23:59:04 +01:00
Earl Warren
c6f7b3f688 developer: infrastructure: code.forgejo.org rotating backups 2023-12-11 22:16:03 +00:00
Earl Warren
13b6b38939
developer: infrastructure: next.forgejo.org 
next.forgejo.org has been lagging for a few weeks in upgrades. While
crystal and dachary are busy, I setup and documented an LXC container
on the machine to which we all have access. It can be switched back to
where it was by updating the DNS entry.
 2023-12-11 22:57:43 +01:00
Earl Warren
8058edc2a0
developer: infrastructure: IP & port forwarding 2023-12-10 14:48:45 +01:00
Earl Warren
0ab4028535 user: actions: automatic tokens do not trigger workflows 2023-12-10 11:28:25 +00:00
Antonin Delpeuch
bc5268061f Change link for Emacs' go mode 2023-12-09 22:46:22 +00:00
Antonin Delpeuch
143454ae94 Remove trailing lines 2023-12-09 22:46:22 +00:00
Antonin Delpeuch
eda0ec8443 Remove GoLand 2023-12-09 22:46:22 +00:00
Antonin Delpeuch
b8e37e4237 Add page to document how to set up a dev environment 2023-12-09 22:46:22 +00:00
Earl Warren
54a3207eb3
admin: search-engines: be precise about where to find CustomPath 2023-12-08 20:31:28 +01:00
Harald Kirsch
ade42a313d adds warning to avoid superfluous https: prefix when using npm registry 2023-12-08 20:14:40 +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
Earl Warren
d2daf216e5 developer: infrastructure: document forgejo-helm runner 
It is special because it needs extended permissions to run k8s tests.
 2023-12-06 16:31:54 +00: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
Earl Warren
69a63cea19
developer: infrastructure at hetzner 
* document the current setup at hetzner01 and maintenance procedures
* document the new hardware setup at hetzner{02,03} for hosting code.forgejo.org
 2023-12-05 22:36:09 +01:00
Earl Warren
a1ead9463a developer: release: fix typo 2023-12-04 18:01:04 +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
Antonin Delpeuch
34791eb810 Document Docker build procedure 
Closes #241.
 2023-12-04 10:53:54 +00:00
oliverpool
d1cfdbc9b1 Revert "developer: release: maintenance policy" 
This reverts commit 506e3961d8.
 2023-11-30 16:21:34 +01:00
oliverpool
b5cdc78e0c admin: release life cycle 2023-11-30 16:00:29 +01:00
oliverpool
eee441b0bb fix number of versions per year 2023-11-29 17:48:05 +00:00
oliverpool
ac4ae83940 s/unstable/experimental 2023-11-29 17:48:05 +00:00
oliverpool
ba7ac6659b developer: release: maintenance policy 2023-11-29 17:48:05 +00:00
Silejonu
a484c04428 fix typo 2023-11-28 10:00:25 +00:00
Earl Warren
5c8175b0d3 developer: release: publish weekly test releases 
Refs: https://codeberg.org/forgejo/discussions/issues/51
 2023-11-27 18:03:37 +00:00
Earl Warren
3591cabfbc
developer: release: tests moved from setup-forgejo to end-to-end 2023-11-27 15:58:28 +01:00
Earl Warren
536b6e10e0
admin: upgrade: update the latest patch release versions 2023-11-25 15:20:48 +01:00
Earl Warren
54fea18974
user: actions: variable values can be modified 2023-11-24 16:58:08 +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
05de9ce86a
user: pull-request: add section on reviews 2023-11-15 23:53:41 +01:00
Earl Warren
927d806dbc
user: pull-request: import from Codeberg 2023-11-15 22:58:54 +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
4bba2896a5
user: label: section about archiving labels 2023-11-15 22:17:04 +01: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
44079f17a4 user: actions: s/options/container.options/ 2023-11-11 00:35:31 +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
7cf8b2fc95
user: actions: clarify pull_request_target will checkout the base 2023-11-08 16:16:59 +01:00
Gusted
fcb6347c18 Refactor blocking users page 
- Update images to the 'new' design and have better consistency with
sizes (using Firefox's screenshot node feature).
- Add section for blocking users as a user of where to find the list of
blocked users and how to unblock them.
 2023-11-03 13:26:24 +00: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
533f575dde
developer/repositories-dependencies: no need to add collaborators 
adding collaborators with write access to the destination repository
is a way for the author of a pull request to gain elevated privileges
 2023-11-01 20:45:42 +01:00
Earl Warren
8bd4dac2dc
user/actions: actions/end-to-end => forgejo/end-to-end 2023-10-29 19:00:25 +01:00
Earl Warren
129702bd6a
user/actions: examples moved to end-to-end 
https://code.forgejo.org/forgejo/end-to-end
 2023-10-29 15:28:34 +01:00
Earl Warren
8cb1dbf218
develop/repositories-dependencies: explain the cascading-pr setup 
It provides two concrete examples to illustrate how they are
useful. It also explains how the permissions and tokens are created
and installed.
 2023-10-26 18:07:41 +02:00
Earl Warren
4e479f5a94 developer/RELEASE: checklist of dependencies for release notes 2023-10-24 11:11:12 +00: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
88269f91ca
user/labels: rework the page entirely 2023-10-23 12:43:29 +02: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
dc58097aec
developer/infrastructure: add Uberspace 
Refs: https://codeberg.org/forgejo/governance/issues/36
 2023-10-20 17:04:33 +02: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
89c24509f0
sync with Codeberg 7bb8fa5ca559073c028805888195ee31b1f3d9c2 
https://codeberg.org/Codeberg/Documentation

git diff 77bfb6cc15d180d506881e9629e73d1064c11dda..7bb8fa5ca559073c028805888195ee31b1f3d9c2 > doc.patch
 2023-10-08 16:28:54 +02:00
Earl Warren
c4a2a40f6f
user: actions: fix links to examples 
* the postgresql.yml file was merged into test.yml
* add links to test.yml directly rather than the directory to save one click
 2023-10-08 00:59:57 +02:00
Earl Warren
aaaff32bb3
user: actions: ony two level of nesting 2023-10-08 00:36:01 +02:00
Earl Warren
8bd50bb4ef
user: actions: explain errors tooltip 2023-10-07 18:02:48 +02: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
6a7a7715d7
user: actions: fix typo 2023-10-05 12:59:02 +02:00
Earl Warren
f543af1e87
{admin,user}: actions: update log & artifact storage & usage 2023-09-30 00:46:03 +02:00
Earl Warren
d0c10d5716
user: actions: add on.pul_request* and on.schedule examples 2023-09-29 14:36:28 +02:00
Earl Warren
1f7a005627 user: actions: on.pull_request_target workflows are not moderated 2023-09-28 16:49:48 +00:00
Earl Warren
f5d5e6d7b4 user: actions: disable / enable a workflow from the UI 
and also update the screenshots of the list of tasks and the details
of a task.
 2023-09-28 16:49:29 +00: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
b4bf3c5a11 user: actions: add `on.pull_request{,_target} 
Also remove the list of types because they are unhelpful and probably
misleading.
 2023-09-28 16:04:56 +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
f1737a5ecd
user: actions: add on.schedule 2023-09-24 23:15:59 +02:00
Earl Warren
df703accac user: actions: variables 
and also update the secrets list & addition screenshots as the layout
has changed
 2023-09-23 15:55:59 +00:00
Earl Warren
a527b6fd23
user: config-cheat-sheet: updates from Gitea 2023-09-22 20:00:16 +02:00
Earl Warren
43a07a1cba user: blame: adapt to Forgejo (#146) 
Caution: it needs to be squashed before merge to be backported. It is kept as two commits to preserve the original version.
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/146
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-22 17:58:24 +00: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
Earl Warren
8cdd6202c7 developer: add warning for make watch 
See https://github.com/go-gitea/gitea/issues/27029
 2023-09-14 06:50:20 +00:00
Gusted
4479191be8
user: add repository transfers to blocking users documentation 
- Ref: https://codeberg.org/forgejo/forgejo/pulls/1436
 2023-09-14 07:59:39 +02:00
Earl Warren
0a53b0a2cf
developer: the minimum node version is 20 
Things will fail in mysterious ways with lower version. For instance when
trying `make watch` the page won't load and complain index.js is not found.
 2023-09-12 18:01:51 +02:00
Earl Warren
ab5076eea3 user: api: explain how to obtain pagination defaults 2023-09-10 09:00:20 +00:00
Flightkick
62d6fc9754 docs: Add an example for registry credentials. 2023-09-10 08:53:05 +00:00
crystal
622ba909cc
fix "customization" typo 2023-09-09 15:07:29 -06: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
firefly-cpp
c090305970 developer:fix link (sustainability) 2023-09-03 22:05:50 +02:00
Caesar Schinas
ca28203c54
admin:database-preparation: use different password from username in examples 2023-09-02 23:20:28 +01:00
Earl Warren
314ca54b64 user: actions: document if (#102) 
Also use YAML pseudo path as chapter headings because it makes it easier to find from the TOC

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/102
Reviewed-by: Caesar Schinas <caesar@caesarschinas.com>
Reviewed-by: Forgejo Release Team <release-team@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
 2023-09-02 19:34:24 +00: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
Gusted
693f849196 developer: add ARCHITECTURE file 
- As per https://codeberg.org/forgejo/discussions/issues/53#issuecomment-1070207
 2023-08-30 17:11:06 +00: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
crystal
b0319eaa02
Add next.forgejo.org documentation 2023-08-29 19:49:52 -06: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
Caesar Schinas
3573e7ceac add link to command-line 2023-08-27 15:18:31 +00:00
Caesar Schinas
713824565b grammar and formatting improvements in command-line 2023-08-27 15:18:31 +00:00
Caesar Schinas
6c5e27d8f9 s/gitea/forgejo/ in command-line docs 2023-08-27 15:18:31 +00:00
Caesar Schinas
b7c2392a4c import command-line docs from Gitea 2023-08-27 15:18:31 +00: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
Caesar Schinas
581d02f1d7
s/Gitea/Forgejo/ 2023-08-27 00:02:54 +01:00
firefly-cpp
475ef3b3c7 user:issue-pull-request-templates:gitea->forgejo in template 2023-08-26 14:44:38 +02:00
Robin Kloppe
cda78ddf2a serveral improvements 2023-08-26 00:12:52 +02:00
Earl Warren
a68070a894
admin: actions: add a section about alternative runners 2023-08-25 10:18:29 +02:00
Robin Kloppe
42dbbba27c Clarified version check endpoint parameters. HTTP_ENDPOINT is now deprecated (#68) 
Clarified version check endpoint parameters. HTTP_ENDPOINT is now deprecated

Closes #49

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/68
Reviewed-by: Caesar Schinas <caesar@caesarschinas.com>
Co-authored-by: Robin Kloppe <git@mainboarder.de>
Co-committed-by: Robin Kloppe <git@mainboarder.de>
 2023-08-24 10:28:46 +00:00
Earl Warren
73a1bcb126 admin: logging-documentation: add documentation for MODE = 2023-08-23 10:42:13 +00:00
Loïc Dachary
f0c9ffab9e developer: release: document the steps 2023-08-22 22:12:41 +00:00
Gusted
2b3136b775 admin: document SLOW_QUERY_TRESHOLD option 
- This is a Forgejo-specific option and the associated pull request is
- https://codeberg.org/forgejo/forgejo/pulls/1284.
- Adding a recommendation to set it to a lower value if an administrator
is investigating poor database performance with Forgejo.
 2023-08-21 21:01:23 +00:00
wh0ami
21517723f4 admin: add hint for known bug with SameSite strict and external OAuth2 providers 2023-08-21 19:29:26 +00:00
Earl Warren
5ea739c8d1
admin: ugprade add notes about v1.20.[12]-0 2023-08-21 10:55:19 +02:00
Caesar Schinas
a3c639ff49 better description of input validation attributes 
Closes https://codeberg.org/forgejo/website/issues/168
 2023-08-19 20:03:28 +00:00
Caesar Schinas
c6ab3c37fb
fix: broken links from Gitea docs import 
Invalid link templates left over from docs import from Gitea.

Closes https://codeberg.org/forgejo/website/issues/160
 2023-08-19 16:26:57 +01:00
Robin Kloppe
4a3f87ad43
Removed Push Options link from User Index - Bug #30 2023-08-18 22:40:37 +02:00
Robin Kloppe
b8c2ed65c9 Replaced mydomain with example - RFC2606, RFC6761 2023-08-18 22:27:55 +02:00
Loïc Dachary
67fdb5449b
developer: link to the CI file for go-version recommendation 2023-08-17 19:01:23 +02:00
Caesar Schinas
2d3459594d
document "And Your Own Notifications" setting 2023-08-17 14:11:28 +01:00
Caesar Schinas
4e059dc7f9
add linting for docs markdown content 2023-08-16 23:57:11 +01:00
Caesar Schinas
27864fec2b
move docs to subfolder 2023-08-15 00:19:15 +01:00