foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-27 18:32:37 -05:00
Code Issues Activity

docs: admin: [attachments] is actually [attachment]

Browse source 
So it actually is [attachment] or [storage.attachments], one singular
and one plural. One more reason to **not** document [storage.XXXX].

# Conflicts:
#	v1.21/admin/config-cheat-sheet.md
#	v1.21/admin/storage.md
This commit is contained in:
Earl Warren 2023-08-10 11:04:42 +02:00 committed by Caesar Schinas
parent fd669862e6
commit 41ee7cc748
No known key found for this signature in database
GPG key ID: AE9108461BEA5ACF
2 changed files with 23 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
admin/config-cheat-sheet.md
View file

@ -1210,14 +1210,14 @@ WARNING: Changing the settings below can break federation.
| storage | default base path | app.ini sections | | storage | default base path | app.ini sections |
| ----------------- | ------------------ | ------------------- | | ----------------- | ------------------ | ------------------- |
| attachments | attachments/ | [attachments] | | Attachments | attachments/ | [attachment] |
| lfs | lfs/ | [lfs] | | LFS | lfs/ | [lfs] |
| avatars | avatars/ | [avatars] | | Avatars | avatars/ | [avatars] |
| repo-avatars | repo-avatars/ | [repo-avatars] | | Repo avatars | repo-avatars/ | [repo-avatars] |
| repo-archive | repo-archive/ | [repo-archive] | | Repo archives | repo-archive/ | [repo-archive] |
| packages | packages/ | [packages] | | Packages | packages/ | [packages] |
| actions_log | actions_log/ | [actions_log] | | Actions logs | actions_log/ | [actions_log] |
| actions_artifacts | actions_artifacts/ | [actions_artifacts] | | Actions Artifacts | actions_artifacts/ | [actions_artifacts] |
The storage configuration for attachments, lfs, avatars, repo-avatars, repo-archive, packages, actions_log, actions_artifact is [explained in detail in a dedicated section](../storage/). The storage configuration for attachments, lfs, avatars, repo-avatars, repo-archive, packages, actions_log, actions_artifact is [explained in detail in a dedicated section](../storage/).

29
admin/storage.md
View file

@ -11,14 +11,14 @@ storage, using the following hierarchy under the `APP_DATA_PATH` directory:
| storage | default base path | app.ini sections | | storage | default base path | app.ini sections |
| ----------------- | ------------------ | ------------------- | | ----------------- | ------------------ | ------------------- |
| attachments | attachments/ | [attachments] | | Attachments | attachments/ | [attachment] |
| lfs | lfs/ | [lfs] | | LFS | lfs/ | [lfs] |
| avatars | avatars/ | [avatars] | | Avatars | avatars/ | [avatars] |
| repo-avatars | repo-avatars/ | [repo-avatars] | | Repo avatars | repo-avatars/ | [repo-avatars] |
| repo-archive | repo-archive/ | [repo-archive] | | Repo archives | repo-archive/ | [repo-archive] |
| packages | packages/ | [packages] | | Packages | packages/ | [packages] |
| actions_log | actions_log/ | [actions_log] | | Actions logs | actions_log/ | [actions_log] |
| actions_artifacts | actions_artifacts/ | [actions_artifacts] | | Actions Artifacts | actions_artifacts/ | [actions_artifacts] |
For instance if `APP_DATA_PATH` was `/appdata`, the default directory to For instance if `APP_DATA_PATH` was `/appdata`, the default directory to
store attachments would be `/appdata/attachments`. store attachments would be `/appdata/attachments`.
@ -41,7 +41,7 @@ for each subsystem in a `[XXXX]` section. For instance setting:
[storage] [storage]
PATH = /mystorage PATH = /mystorage
[attachments] [attachment]
PATH = /otherstorage/attachments PATH = /otherstorage/attachments
``` ```
@ -114,7 +114,7 @@ For instance:
[storage] [storage]
PATH = /default PATH = /default
[attachments] [attachment]
PATH = /first PATH = /first
``` ```
@ -122,7 +122,8 @@ Will set the value of `PATH` for attachments to `/first`.
## Undocumented features ## Undocumented features
It is **strongly** recommended to avoid using undocumented features It is **strongly** recommended to avoid using undocumented features -
(such as `[storage.attachments]` as an alternative to `[attachments]` such as `[storage.attachments]` as an alternative to `[attachment]`
for instance) because their behavior is not thoroughly tested and may for instance (the plural is not a typo, it is a unification problem) -
lead to unexpected results. because their behavior is not thoroughly tested and may lead to
unexpected results.