2024-07-07 16:08:10 +00:00
|
|
|
# NAME
|
|
|
|
|
|
|
|
|
|
git-annex-p2phttp - HTTP server for git-annex P2P protocol
|
|
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2024-07-09 21:30:55 +00:00
|
|
|
git-annex p2phttp
|
2024-07-07 16:08:10 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
|
|
|
This allows a git-annex repository to be accessed over HTTP.
|
|
|
|
|
It is the git-annex equivilant of git-http-backend(1), for serving
|
|
|
|
|
a repository over HTTP with write access for authenticated users.
|
|
|
|
|
|
2024-07-09 21:30:55 +00:00
|
|
|
# OPTIONS
|
|
|
|
|
|
2024-07-10 16:19:47 +00:00
|
|
|
* `--jobs=N`
|
|
|
|
|
|
|
|
|
|
Use this or annex.jobs must be set to configure the number of worker
|
|
|
|
|
threads.
|
|
|
|
|
|
|
|
|
|
Since the webserver itself uses one thread, this needs to be set to
|
|
|
|
|
2 or more.
|
|
|
|
|
|
2024-07-10 03:44:40 +00:00
|
|
|
* `--port=N`
|
|
|
|
|
|
|
|
|
|
Port to listen on. Default is port 80.
|
|
|
|
|
|
2024-07-09 21:30:55 +00:00
|
|
|
* `--authenv`
|
|
|
|
|
|
|
|
|
|
Allows users to be authenticated with a username and password.
|
|
|
|
|
For security, this only allows authentication when the user connects over
|
|
|
|
|
HTTPS.
|
|
|
|
|
|
|
|
|
|
To configure the passwords, set environment variables
|
|
|
|
|
like `GIT_ANNEX_P2PHTTP_PASSWORD_alice=foo123`
|
|
|
|
|
|
|
|
|
|
The permissions of users can also be configured by setting
|
|
|
|
|
environment variables like
|
|
|
|
|
`GIT_ANNEX_P2PHTTP_PERMISSIONS_alice=readonly`. The value
|
|
|
|
|
can be either "readonly" or "appendonly". When this is not set,
|
|
|
|
|
the default is to give the user full write access.
|
|
|
|
|
|
|
|
|
|
* `--authenv-http`
|
|
|
|
|
|
|
|
|
|
Like `--authenv`, but allows authentication when the user connects
|
|
|
|
|
over HTTP. This is not secure, since HTTP basic authentication is not
|
|
|
|
|
encrypted.
|
|
|
|
|
|
2024-07-10 03:44:40 +00:00
|
|
|
* `--unauth-readonly`
|
2024-07-09 21:30:55 +00:00
|
|
|
|
|
|
|
|
Allows unauthenticated users to read the repository, but not make
|
|
|
|
|
modifications to it.
|
|
|
|
|
|
2024-07-10 03:44:40 +00:00
|
|
|
* `--unauth-appendonly`
|
2024-07-09 21:30:55 +00:00
|
|
|
|
|
|
|
|
Allows unauthenticated users to read the repository, and store data in
|
|
|
|
|
it, but not remove data from it.
|
|
|
|
|
|
|
|
|
|
* `--wideopen`
|
|
|
|
|
|
2024-07-10 03:44:40 +00:00
|
|
|
Gives unauthenticated users full read+write access to the repository.
|
2024-07-09 21:30:55 +00:00
|
|
|
|
|
|
|
|
Please think carefully before enabling this option.
|
|
|
|
|
|
2024-07-07 16:08:10 +00:00
|
|
|
# SEE ALSO
|
|
|
|
|
|
|
|
|
|
[[git-annex]](1)
|
|
|
|
|
|
|
|
|
|
git-http-backend(1)
|
|
|
|
|
|
|
|
|
|
[[git-annex-shell]](1)
|
|
|
|
|
|
|
|
|
|
<https://git-annex.branchable.com/design/p2p_protocol_over_http/>
|
|
|
|
|
|
|
|
|
|
# AUTHOR
|
|
|
|
|
|
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
|
|
|
|
|
|
<http://git-annex.branchable.com/>
|
|
|
|
|
|
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care
|
