git-annex/doc/git-annex-webapp.mdwn
Joey Hess 8e9ee31621
webapp: Added --port option, and annex.port config
The getSocket comment that mentioned using ":port"
in the hostname seems to have been incorrect or be out of date.
After all, the bug report came when the user first tried doing that,
and it didn't work.

Sponsored-by: the NIH-funded NICEMAN (ReproNim TR&D3) project
2024-01-25 14:08:36 -04:00

60 lines
1.6 KiB
Markdown

# NAME
git-annex webapp - launch webapp
# SYNOPSIS
git annex webapp
# DESCRIPTION
Opens a web app, that allows easy setup of a git-annex repository,
and control of the git-annex assistant. If the assistant is not
already running, it will be started. This will cause new files to
be added and syncing operations to be performed.
By default, the webapp can only be accessed from localhost, and running
it opens a browser window.
# OPTIONS
* `--listen=address`
Useful for using the webapp on a remote computer. This makes the webapp
listen on the specified IP address. (Or on the address that a specified
hostname resolves to.)
This disables running a local web browser, and outputs the url you
can use to open the webapp.
Set annex.listen in the git config to make the webapp always
listen on an IP address.
* `--port=number`
Use this option to specify a port for the webapp.
By default, the webapp picks an unused port.
* Also the [[git-annex-common-options]](1) can be used.
# USING HTTPS
When using the webapp on a remote computer, you'll almost certainly
want to enable HTTPS. The webapp will use HTTPS if it finds
a .git/annex/privkey.pem and .git/annex/certificate.pem. Here's
one way to generate those files, using a self-signed certificate:
openssl genrsa -out .git/annex/privkey.pem 4096
openssl req -new -x509 -key .git/annex/privkey.pem > .git/annex/certificate.pem
# SEE ALSO
[[git-annex]](1)
[[git-annex-assistant]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.