aboutsummaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
authorᴜɴᴋɴᴡᴏɴ <u@gogs.io>2020-05-10 20:37:22 +0800
committerGitHub <noreply@github.com>2020-05-10 20:37:22 +0800
commit1125bb5848006d1269355475553426340af62254 (patch)
treeceec3840c8d523c6c6a28ab45360770d7b8e6326 /docs/admin
parent44ea9604ed7440c2cf1105d965c2429ee225e8f6 (diff)
lfs: add user and admin docs (#6158)
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/lfs.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/admin/lfs.md b/docs/admin/lfs.md
new file mode 100644
index 00000000..143552ec
--- /dev/null
+++ b/docs/admin/lfs.md
@@ -0,0 +1,21 @@
+# Configuring Git Large File Storage (LFS)
+
+> NOTE: Git LFS is supported in Gogs starting with version 0.12.
+
+Git LFS works out of box with default configuration for any supported versions.
+
+## Known limitations
+
+- Only local storage is supported (i.e. all LFS objects are stored on the same server where Gogs runs), support of Object Storage Service like Amazon S3 is being tracked in [#6065](https://github.com/gogs/gogs/issues/6065).
+
+## Configuration
+
+All configuration options for Git LFS are located in [`[lfs]` section](https://github.com/gogs/gogs/blob/44ea9604ed7440c2cf1105d965c2429ee225e8f6/conf/app.ini#L266-L270):
+
+```ini
+[lfs]
+; The storage backend for uploading new objects.
+STORAGE = local
+; The root path to store LFS objects on local file system.
+OBJECTS_PATH = data/lfs-objects
+```