summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7f94626f..ee3c9cca 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
+# Parabolaweb README
+
+It is recommended that you just install the (Parabola) package
+`parabolaweb-utils`, it
+
+ - 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.
+
# Archweb README
To get a pretty version of this document, run