mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

document p2phttp --directory

Browse source 
The option is not implemented yet.
This commit is contained in:
Joey Hess 2024-11-20 13:40:38 -04:00
parent 07026cf58b
commit d7ed99a55f
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 28 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG
View file

@ -21,6 +21,8 @@ git-annex (10.20241032) UNRELEASED; urgency=medium
uses the same hostname as remote.name.url, which is itself a http(s)
url, they are assumed to share a username and password. This avoids
unnecessary duplicate password prompts.
* p2phttp: Added --directory option which serves all git-annex
repositories located inside a directory.
-- Joey Hess <id@joeyh.name> Mon, 11 Nov 2024 12:26:00 -0400

31
doc/git-annex-p2phttp.mdwn
View file

@ -12,9 +12,13 @@ This is a HTTP server for the git-annex API.
It is the git-annex equivilant of git-http-backend(1), for serving
a repository over HTTP with write access for authenticated users.
This does not serve the git repository over HTTP, only the git-annex
This does not serve a git repository over HTTP, only the git-annex
API.
By default, this serves the git-annex API for the git-annex repository
in the current working directory. It can also serve more than one
repository, see the `--directory` parameter.
Typically a remote will have `remote.name.url` set to a http url
as usual, and `remote.name.annexUrl` set to an annex+http url such as
"annex+http://example.com/git-annex/". The annex+http url is
@ -35,10 +39,25 @@ convenient way to download the content of any key, by using the path
# OPTIONS
* `--directory=path`
Serve each git-annex repository found in a directory. This does not
recurse into subdirectories.
This option can be provided more than once to serve serveral directories
full of git-annex repositories.
New git-annex repositories can be added to the directory, and will be
noticed and served immediately. There is no need to restart the server.
When a git-annex repository is removed from the directory, the server
will stop serving it as well. This may not be immediate, as some files
in the deleted repository may still be open.
* `--jobs=N` `-JN`
This or annex.jobs must be set to configure the number of worker
threads that serve connections to the webserver.
threads, per repository served, that serve connections to the webserver.
Since the webserver itself also uses one of these threads,
this needs to be set to 2 or more.
@ -47,15 +66,15 @@ convenient way to download the content of any key, by using the path
* `--proxyconnections=N`
When this command is run in a repository that is configured to act as a
proxy for some of its remotes, this is the maximum number of idle
connections to keep open to proxied remotes.
When serving a repository that is configured to act as a proxy for some
of its remotes, this is the maximum number of idle connections to keep
open to proxied remotes.
The default is 1.
* `--clusterjobs=N`
When this command is run in a repository that is a gateway for a cluster,
When serving a repository that is a gateway for a cluster,
this is the number of concurrent jobs to use to access nodes of the
cluster, per connection to the webserver.