aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 434e4da..fd72cb2 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,9 @@
1gitolfs3 1Gitolfs3: a very simple Git LFS server
2======== 2========
3 3
4Gitolfs3 is a very simple Git LFS server. 4Gitolfs3 has a singular purpose: provide me with a personal Git LFS server that
5 5I can run on my VPS, that stores objects in S3. It seems to be doing an okay
6It needs to do one thing: provide me with a personal Git LFS server that I can 6job at it so far.
7run on my VPS. It seems to be doing an okay job at it so far.
8 7
9The name 'Gitolfs3' started as some kind of concoction of Gitolite, LFS and S3. 8The name 'Gitolfs3' started as some kind of concoction of Gitolite, LFS and S3.
10These days, this project has nothing to do with Gitolite because I don't use 9These days, this project has nothing to do with Gitolite because I don't use
@@ -14,7 +13,7 @@ the complexity of my system down as much as possible.)
14Currently, it has the following features: 13Currently, it has the following features:
15 14
16- Storage with S3-compatible services (at the moment of writing, I am using 15- Storage with S3-compatible services (at the moment of writing, I am using
17 Scaleway Object Storage for this purpose) 16 Scaleway Object Storage for this purpose).
18- Git LFS Batch API support. Only the basic transfer adapter is supported. Only 17- Git LFS Batch API support. Only the basic transfer adapter is supported. Only
19 SHA256 Object IDs (OIDs) are supported. 18 SHA256 Object IDs (OIDs) are supported.
20- `git-lfs-authenticate` is provided for authentication over SSH. File transfer 19- `git-lfs-authenticate` is provided for authentication over SSH. File transfer
@@ -47,3 +46,11 @@ use cases than me. In case you want to use this software, feel free to, but
47expect that you will basically have to 'make it your own'. If you have a 46expect that you will basically have to 'make it your own'. If you have a
48burning question or find a security vulnerability, feel free to email me. I'm 47burning question or find a security vulnerability, feel free to email me. I'm
49sure you'll manage to find my email address somewhere. 48sure you'll manage to find my email address somewhere.
49
50Missing features that I might implement at some point when I care enough:
51
52- No namespacing on S3. (This would mean that having the same big file in two
53 repositories would mean it is only stored on S3 once.)
54- Any kind of file deletion/garbage collection. If you ever have the need, you
55 need to do this manually right now.
56- Resuming downloads.