summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-02-28 22:39:06 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-02-28 22:39:06 -0400
commitd45ea6098b3fc0d8c98a7e7984f637655b637322 (patch)
tree79023dd2a3eaeecd1bd77ab1d6d235cbe6d47eaa /doc/git-annex.mdwn
parent43e7407f8e317f2e05f24041adea09347f90466e (diff)
docs for remote webapp, securely
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn17
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 9b9b53902..40e6adb2a 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -307,11 +307,18 @@ subdirectories).
By default, the webapp can only be accessed from localhost, and running
it opens a browser window.
- With the `--listen=address[:port]` option, the webapp can be made to listen
- for connections on the specified address. This disables running a
- local web browser, and outputs the url you can use to open the webapp
- from a remote computer.
- Note that this does not yet use HTTPS for security, so use with caution!
+ To use the webapp on a remote computer, use the `--listen=address`
+ option to specify the address the web server should listen on.
+ This disables running a local web browser, and outputs the url you
+ can use to open the webapp.
+
+ When using the webapp on a remote computer, you'll almost certianly
+ 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
# REPOSITORY SETUP COMMANDS