summaryrefslogtreecommitdiff
path: root/README.mediawiki
diff options
context:
space:
mode:
authorAlon Levy <alon@pobox.com>2015-01-12 11:19:39 +0200
committerAlon Levy <alon@pobox.com>2015-01-12 11:20:02 +0200
commitdb5dfcbec8cc1fa2ea9110f59adcd7972bd657a9 (patch)
tree2e8d081997542074221e810bdf7adcce6427c698 /README.mediawiki
parent34414fb0d45c274a03a8b01de4688e8ae50702c2 (diff)
server: implement init_pw_db, update docs, set default Config.htpasswd_path to <config-dir>/htpasswd
TODO: permissions - warn on lax permissions for password file (and for init file?)
Diffstat (limited to 'README.mediawiki')
-rw-r--r--README.mediawiki14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.mediawiki b/README.mediawiki
index 1484ffc3..58fda93e 100644
--- a/README.mediawiki
+++ b/README.mediawiki
@@ -25,13 +25,27 @@ To run Rhizi locally:
For testing locally run neo4j locally on the default 7474 port and then launch run-local.sh:<br><code>./run-local.sh</code>
Or perform the following tasks by hand:
+# Update css files from scss sources using <code>make</code>
# Invoke the local deployment Ant target:<br><code>$ cd ./rhizi && ant -f build.ant deploy-local</code>
# Assert Neo4J is running and listening on it's default port
# Run rhizi-server.py:<br><code>$ cd deploy-local && python bin/rz_server.py --config-dir=etc</code>
Command line use documentation can be view with:
:$ python rz_server.py -h
+
+== Installation ==
+
+=== Setup user password file ===
+The following works in conjunction with run-local.sh, for real deployment place the resulting htpasswd file in the location matching the config you use.
+# put a SECRET_KEY entry in the config file:
+ echo SECRET_KEY=mysecret >> res/etc/rhizi-server.conf
+# create an initialization file with email/password separated by a comma:
+ echo test@example.com,test > res/etc/htpasswd-init-file
+# create the htpasswd file:
+ python src/server/rz_server.py --init-htpasswd-db --htpasswd-init-file res/etc/htpasswd-init-file
+
= Development =
+
To update the css files you need [sass](http://sass-lang.com/)
The build tool is [make](https://www.gnu.org/software/make/)