X-Git-Url: https://code.wpia.club/?p=motion.git;a=blobdiff_plain;f=README.md;h=3bbaeb5f91c15d8d5262a58b73eea315e19a42aa;hp=4681fba5a1932027620cb3e18a664d585ed429fd;hb=7f7b44cb967ae9b99ddcbf3879c92d448570d49c;hpb=602ae3c596df4d1306594d5da37a17628b79a1d2 diff --git a/README.md b/README.md index 4681fba..3bbaeb5 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ virtualenv -p python3 . . bin/activate pip install -r requirements.txt ``` -Then edit config.py.example into config.py with your database connection +Then edit config.py.example into config.py with your database connection and web site settings ## Development and debug @@ -39,6 +39,7 @@ The following user rights can be granted: - cancel: user is able to cancel a running motion - finish: user is able to close a running motion - audit: user is able to see given votes of a finished motion +- proxyadmin: user is able to grant proxy rights for users To grant right use the following (here with vote right as example): - on all groups add "vote:*" @@ -49,7 +50,7 @@ To grant right use the following (here with vote right as example): Within the motion content markdown can be used for formatting e.g. * To add a line break add two lines -* to enter a link use `[text](https//domain.tld/link)` +* to enter a link use `[text](https://domain.tld/link)` ## Settings for nginx @@ -179,3 +180,38 @@ Add Publish JUnit test result report - test report XMLs ``` python_tests_xml/* ``` + +## Add user via command line + +For linux start with +``` +FLASK_APP=motion.py +``` + +For windows start with +``` +set FLASK_APP=motion.py + +``` + +To add a user use this command +``` +flask create-user "email address" "host" + +``` + +The application will return a message for success. + +To mask motions use this command +``` +flask motion_masking motionidentifier motionurl host" + +``` + +where: + +* motionidentifier - the motion identifier or left part of it which should be cleaned +* motionurl - an url to a motion that is the reason for the cleanup +* host - host where the motions are located + +The application will return a message for success.