From 813b5bd600ad0bcbb261f945f75dd184eb47bc60 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Tue, 17 May 2016 18:25:48 -0400 Subject: update developer documentation --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7754d961..ee3c9cca 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ # Parabolaweb README -It is recommended that you just install the (parabola) package + +It is recommended that you just install the (Parabola) package `parabolaweb-utils`, it - - depends on the dependencies of parabolaweb - - offers initscripts and systemd service files for parabolaweb - - has a `parabolaweb-update` script that does most of the things here. + - depends on the dependencies of parabolaweb (that is, don't use + virtualenv) + - has a `parabolaweb-update` program that does most of the things here + - has a `parabolaweb-changepassword` program that allows system users + to change their parabolaweb password + - has `/etc/uwsgi/parabolaweb.ini.example` + +To run parabolaweb, you can use `./manage testserver` to run a small +HTTP server, or run `systemctl enable --now uwsgi@parabolaweb.socket`, +and stick that behind a proper web server that speaks WSGI (such as +Nginx). Following is Archweb's readme, as I figure it might be useful for some people, but I have given up on maintaining it for parabolaweb. -- cgit v1.2.3