From 3ec494581867f55da273f1c803d2cebabc60072a Mon Sep 17 00:00:00 2001 From: Miguel BarĂ£o Date: Sat, 20 Apr 2019 23:15:18 +0100 Subject: [PATCH] fix README.md and gitignore --- .gitignore | 5 +++++ README.md | 20 ++++++++++++-------- 2 files changed, 17 insertions(+), 8 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0e35d99 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Specify filepatterns you want git to ignore. +/aprendizations.egg-info/ +/aprendizations/__pycache__/ +/demo/students.db +/node_modules/ \ No newline at end of file diff --git a/README.md b/README.md index 3514844..b1bfa10 100644 --- a/README.md +++ b/README.md @@ -79,15 +79,18 @@ At this point aprendizations can be run anywhere with the command `aprendization The user data is maintained in a sqlite3 database file. We first need to create the database: ```sh -cd aprendizations -./initdb.py # show current database or initialize empty if nonexisting -./initdb.py --admin # add admin user -./initdb.py inscricoes.csv # add students from CSV, passwords are the numbers -./initdb.py --add 1184 "Aladino da Silva" # add new user (default password=1184) -./initdb.py --update 1184 --pw alibaba # update password of given student -./initdb.py --help # for the available options +cd demo +initdb-aprendizations # show or initialize database +initdb-aprendizations --admin # add admin user +initdb-aprendizations inscricoes.csv # add students from CSV +initdb-aprendizations --add 1184 "Aladino da Silva" # add user +initdb-aprendizations --update 1184 --pw alibaba # update password +initdb-aprendizations --help # for the available options ``` +The default password is equal to the user name used to login. + + ### SSL Certificates We need certificates for https. Certificates can be self-signed or validated by a trusted authority. @@ -141,7 +144,8 @@ and then copy the `cert.pem` and `privkey.pem` files to `aprendizations/certs` d The application includes a small example in `demo/demo.yaml`. Run it with ```sh -./serve.py demo/demo.yaml +cd demo +aprendizations demo.yaml ``` and open a browser at [https://127.0.0.1:8443](). If it everything looks good, check at the correct address `https://www.example.com` (requires port forward in the firewall). The option `--debug` provides more verbose logging and might be useful during testing. -- libgit2 0.21.2