aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2018-05-31 02:52:43 +0200
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2018-05-31 02:52:43 +0200
commit4ab4c1d0ba31d437e05792719fba664a94521819 (patch)
tree953bf2925e1c96f95be28132a5459b82bd5a51bf /man
parent56e07b6224fce7e213bfb9b4d00b93628a50aca7 (diff)
downloadblogc-4ab4c1d0ba31d437e05792719fba664a94521819.tar.gz
blogc-4ab4c1d0ba31d437e05792719fba664a94521819.tar.bz2
blogc-4ab4c1d0ba31d437e05792719fba664a94521819.zip
git-receiver: allow users to define builds dir
Diffstat (limited to 'man')
-rw-r--r--man/blogc-git-receiver.1.ronn16
1 files changed, 12 insertions, 4 deletions
diff --git a/man/blogc-git-receiver.1.ronn b/man/blogc-git-receiver.1.ronn
index 7386909..5759bac 100644
--- a/man/blogc-git-receiver.1.ronn
+++ b/man/blogc-git-receiver.1.ronn
@@ -147,13 +147,21 @@ your mirror repository.
## ENVIRONMENT
-The following variable can be set in the SSH Server (usually in `~/.ssh/environment`)
+The following variables 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
+ * `BLOGC_GIT_RECEIVER_BASE_DIR`:
+ Path to the base directory that should be used by `blogc-git-receiver`. Defaults
+ to user's home directory. Useful for shared hosting environments that only provide
one shell user.
+ * `BLOGC_GIT_RECEIVER_BUILDS_DIR`:
+ Path to the directory that should be used to store the blogc builds. Defaults
+ to `$BLOGC_GIT_RECEIVER_BASE_DIR/builds`. This directory must be readable by
+ your webserver. This variable is useful to keep your git repositories unreadable,
+ while letting your webserver access the built files`1. In this case, users need to
+ also define custom symlinks for every repository in
+ `$BLOGC_GIT_RECEIVER_BASE_DIR/blogc-git-receiver.ini`, because the default
+ `htdocs` symlink inside the git repositories won't be acessible by the webserver.
The following variable is exported by `blogc-git-receiver` when building websites
with make(1):