aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-webapp.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 15:36:10 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 15:36:10 -0400
commit90c35465528195367cc4ed1e15478285d7b063f3 (patch)
treefc658fb5d483ad673d82bfa5c3d00bc4a7c2d5ef /doc/git-annex-webapp.mdwn
parent052e77469015e82ca33733388ff5740fa06312e2 (diff)
splitting up the man page
Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands..
Diffstat (limited to 'doc/git-annex-webapp.mdwn')
-rw-r--r--doc/git-annex-webapp.mdwn49
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/git-annex-webapp.mdwn b/doc/git-annex-webapp.mdwn
new file mode 100644
index 000000000..d9e34a2e3
--- /dev/null
+++ b/doc/git-annex-webapp.mdwn
@@ -0,0 +1,49 @@
+# 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.
+
+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 address.
+
+ 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 address.
+
+# 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)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.