aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2018-05-30 22:19:59 +0200
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2018-05-30 22:19:59 +0200
commit9acec235a6c47c3bede917187808a8acd1369050 (patch)
treede32925e547c9b52a307d7b987370d1145936943 /man
parentb42538956a08f009060a56c48f8844f96165daa4 (diff)
downloadblogc-9acec235a6c47c3bede917187808a8acd1369050.tar.gz
blogc-9acec235a6c47c3bede917187808a8acd1369050.tar.bz2
blogc-9acec235a6c47c3bede917187808a8acd1369050.zip
git-receiver: allow users to change the base directory
this is useful mostly for shared environments that just provide one shell user.
Diffstat (limited to 'man')
-rw-r--r--man/blogc-git-receiver.1.ronn23
1 files changed, 17 insertions, 6 deletions
diff --git a/man/blogc-git-receiver.1.ronn b/man/blogc-git-receiver.1.ronn
index 355aa75..7386909 100644
--- a/man/blogc-git-receiver.1.ronn
+++ b/man/blogc-git-receiver.1.ronn
@@ -145,13 +145,24 @@ mirror, you can run its `post-receive` hook manually in the server:
WARNING: If you push manually and your server's repository is empty, you'll clean
your mirror repository.
-## ENVIRONMENT VARIABLES
+## ENVIRONMENT
-`blogc-git-receiver` will export an environment variable called `BLOGC_GIT_RECEIVER`
-when calling `gmake` to build websites. This variable can be used to enable building
-of content that should only be built when running in production environment, for
-example. This variable will not be added when using blogc-make(1), whose builds are
-always considered to be "production" (blogc-make(1) is never called with `-D`).
+The following variable can be set in the SSH Server (usually in `~/.ssh/environment`)
+to change `blogc-git-receiver` behaviour:
+
+ * `BLOGC_GIT_RECEIVER_BASEDIR`:
+ Path to a directory that should be used by `blogc-git-receiver` instead of the
+ user's home directory. Useful for shared hosting environments that only provide
+ one shell user.
+
+The following variable is exported by `blogc-git-receiver` when building websites
+with make(1):
+
+ * `BLOGC_GIT_RECEIVER=1`:
+ This variable can be used to enable building of content that should only be
+ built when running in production environment, for example. This variable will
+ not be exported when using blogc-make(1), whose builds are always considered to
+ be "production" (blogc-make(1) is never called with `-D`).
## BUGS