aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Rutger Broekhoff2024-04-26 20:22:04 +0200
committerLibravatar Rutger Broekhoff2024-04-26 20:22:04 +0200
commit0777ff5528b810b865bc122b4a4e0d1e07146fd7 (patch)
treed8dd4fdd3f3ee3a925e5f1849156f118415a3fcf
parentdb3dbc6aaa29f9d34514bac14dbcbd9918901205 (diff)
downloadgitolfs3-0777ff5528b810b865bc122b4a4e0d1e07146fd7.tar.gz
gitolfs3-0777ff5528b810b865bc122b4a4e0d1e07146fd7.zip
Update README
-rw-r--r--README.md42
-rw-r--r--README.txt10
2 files changed, 42 insertions, 10 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e193da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
1gitolfs3
2========
3
4Gitolfs3 is a very simple Git LFS server.
5
6It needs to do one thing: provide me with a personal Git LFS server that I can
7run on my VPS. It seems to be doing an okay job at it so far.
8
9The 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
11Gitolite anymore. (It was too extensive for my use case, and I prefer to keep
12the complexity of my system down as much as possible.)
13
14Currently, it has the following features:
15- Storage with S3-compatible services (at the moment of writing, I am using
16 Scaleway Object Storage for this purpose)
17- Git LFS Batch API support. Only the basic transfer adapter is supported. Only
18 SHA256 Object IDs (OIDs) are supported.
19- `git-lfs-authenticate` is provided for authentication over SSH. File transfer
20 over SSH using `git-lfs-transfer` is not supported.
21- A Git shell is provided so that I can stay sane. (I don't recall 100%, but I
22 believe this was nice when wanting to push to some ssh://git@asdf/blabla.git
23 repo without having to type `/srv/git` before the repo name. And I don't want
24 to have to use something like Gitolite.)
25- Public/private repos based on the `git-daemon-export-ok` file in the bare
26 repo. (I have a very particular setup in which this is desirable.)
27 - Downloads for files in public repositories are 'proxied' through the
28 Gitolfs3 server, at least when accessed from the public internet.
29 - Unauthenticated users accessing the service over a private network
30 (authorized by `X-Fowarded-Host`) can access all repositories. Downloads
31 for these users are not proxied: instead, they are directed to pre-signed
32 S3 download URLs.
33 - Authenticated users can download and upload for all repositories,
34 regardless of how they access the service.
35
36This program, as it is, solely serves my needs. Although I may occasionally add
37some features or perform some cleanups (especially the server still requires
38some), I have no interest in making this program work for people with different
39use cases than me. In case you want to use this software, feel free to, but
40expect that you will basically have to 'make it your own'. If you have a
41burning question or find a security vulnerability, feel free to email me. I'm
42sure you'll manage to find my email address somewhere.
diff --git a/README.txt b/README.txt
deleted file mode 100644
index b71871f..0000000
--- a/README.txt
+++ /dev/null
@@ -1,10 +0,0 @@
1gitolfs3
2========
3
4Yes, this is indeed an integration between Git LFS and Scaleway Object Storage.
5
6To be honest, the code is pretty bad right now and solely serves my needs.
7Although I will be doing some cleanups, I have no interest in making this
8program work for people with different use cases than me. In case you want to
9use this software, feel free to, but expect that you will basically have to
10'make it your own'.