diff options
author | Rutger Broekhoff | 2024-04-29 19:38:21 +0200 |
---|---|---|
committer | Rutger Broekhoff | 2024-04-29 19:38:21 +0200 |
commit | 58cda3c6d2135e652c025c6b586cecf014ff2ad6 (patch) | |
tree | 1c9e0e93b6938cd48113e93e1cfeb361cdbf710f | |
parent | a249ff676de19c4a913362b0b6b5d9fef8b16996 (diff) | |
download | gitolfs3-58cda3c6d2135e652c025c6b586cecf014ff2ad6.tar.gz gitolfs3-58cda3c6d2135e652c025c6b586cecf014ff2ad6.zip |
Update README
-rw-r--r-- | README.md | 19 |
1 files changed, 13 insertions, 6 deletions
@@ -1,10 +1,9 @@ | |||
1 | gitolfs3 | 1 | Gitolfs3: a very simple Git LFS server |
2 | ======== | 2 | ======== |
3 | 3 | ||
4 | Gitolfs3 is a very simple Git LFS server. | 4 | Gitolfs3 has a singular purpose: provide me with a personal Git LFS server that |
5 | 5 | I can run on my VPS, that stores objects in S3. It seems to be doing an okay | |
6 | It needs to do one thing: provide me with a personal Git LFS server that I can | 6 | job at it so far. |
7 | run on my VPS. It seems to be doing an okay job at it so far. | ||
8 | 7 | ||
9 | The name 'Gitolfs3' started as some kind of concoction of Gitolite, LFS and S3. | 8 | The name 'Gitolfs3' started as some kind of concoction of Gitolite, LFS and S3. |
10 | These days, this project has nothing to do with Gitolite because I don't use | 9 | These 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.) | |||
14 | Currently, it has the following features: | 13 | Currently, 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 | |||
47 | expect that you will basically have to 'make it your own'. If you have a | 46 | expect that you will basically have to 'make it your own'. If you have a |
48 | burning question or find a security vulnerability, feel free to email me. I'm | 47 | burning question or find a security vulnerability, feel free to email me. I'm |
49 | sure you'll manage to find my email address somewhere. | 48 | sure you'll manage to find my email address somewhere. |
49 | |||
50 | Missing 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. | ||