Updated readme and pushed fix to launchpad

This commit is contained in:
boltgolt 2018-04-09 19:33:42 +02:00
parent 2b72f2b6ee
commit 13d5f8ae1a
4 changed files with 28 additions and 7 deletions

View file

@ -1,4 +1,4 @@
# Howdy for Ubuntu # Howdy for Ubuntu ![Build Status](https://travis-ci.org/Boltgolt/howdy.svg?branch=master)
Windows Hello™ style authentication for Ubuntu. Use your built-in IR emitters and camera in combination with face recognition to prove who you are. Windows Hello™ style authentication for Ubuntu. Use your built-in IR emitters and camera in combination with face recognition to prove who you are.
@ -6,10 +6,12 @@ Using the central authentication system in Linux (PAM), this works everywhere yo
### Installation ### Installation
Run the installer by pasting (`ctrl+shift+V`) the following command into the terminal: Run the installer by pasting (`ctrl+shift+V`) the following commands into the terminal one at a time:
``` ```
wget -O /tmp/howdy_install.py https://raw.githubusercontent.com/Boltgolt/howdy/master/installer.py && sudo python3 /tmp/howdy_install.py sudo add-apt-repository ppa:boltgolt/howdy
sudo apt update
sudo apt install howdy
``` ```
This will guide you through the installation. When that's done run `sudo howdy USER add` and replace `USER` with your username to add a face model. This will guide you through the installation. When that's done run `sudo howdy USER add` and replace `USER` with your username to add a face model.
@ -22,6 +24,17 @@ If nothing went wrong we should be able to run sudo by just showing your face. O
The installer adds a `howdy` command to manage face models for the current user. Use `howdy help` to list the available options. The installer adds a `howdy` command to manage face models for the current user. Use `howdy help` to list the available options.
| Command | Description | Needs user |
|-----------|-----------------------------------------------|------------|
| `add` | Add a new face model for the given user | Yes |
| `clear` | Remove all face models for the given user | Yes |
| `config` | Open the config file in nano | No |
| `disable` | Disable or enable howdy | No |
| `help` | Show a help page | No |
| `list` | List all saved face models for the given user | Yes |
| `remove` | Remove a specific model for the given user | Yes |
| `test` | Test the camera and recognition methods | No |
### Troubleshooting ### Troubleshooting
Any python errors get logged directly into the console and should indicate what went wrong. If authentication still fails but no errors are printed you could take a look at the last lines in `/var/log/auth.log` to see if anything has been reported there. Any python errors get logged directly into the console and should indicate what went wrong. If authentication still fails but no errors are printed you could take a look at the last lines in `/var/log/auth.log` to see if anything has been reported there.

10
debian/changelog vendored
View file

@ -1,5 +1,11 @@
howdy (2.0.0) UNRELEASED; urgency=low howdy (2.0.0-alpha+2) xenial; urgency=medium
* Initial release. * Fixed build dependency issue
-- boltgolt <boltgolt@gmail.com> Sat, 07 Apr 2018 21:30:48 +0200
howdy (2.0.0-alpha+1) xenial; urgency=low
* Initial packaged release.
-- boltgolt <boltgolt@gmail.com> Wed, 04 Apr 2018 18:13:15 +0200 -- boltgolt <boltgolt@gmail.com> Wed, 04 Apr 2018 18:13:15 +0200

2
debian/control vendored
View file

@ -2,7 +2,7 @@ Source: howdy
Section: misc Section: misc
Priority: optional Priority: optional
Standards-Version: 3 Standards-Version: 3
Build-Depends: python, dh-python Build-Depends: python, dh-python, devscripts, dh-make
Maintainer: boltgolt <boltgolt@gmail.com> Maintainer: boltgolt <boltgolt@gmail.com>
Vcs-Git: https://github.com/Boltgolt/howdy Vcs-Git: https://github.com/Boltgolt/howdy

View file

@ -30,7 +30,7 @@ else:
# Requre sudo for comamnds that need root rights to read the model files # Requre sudo for comamnds that need root rights to read the model files
if os.getenv("SUDO_USER") is None: if os.getenv("SUDO_USER") is None:
print("Please run this command with sudo") print("Please run this command with sudo")
sys.exit() sys.exit(1)
# Frome here on we require the second argument to be the username, # Frome here on we require the second argument to be the username,
# switching the command to the 3rd # switching the command to the 3rd
@ -48,6 +48,8 @@ else:
# If the comand is invalid, check if the user hasn't swapped the username and command # If the comand is invalid, check if the user hasn't swapped the username and command
if sys.argv[1] in ["list", "add", "remove", "clear"]: if sys.argv[1] in ["list", "add", "remove", "clear"]:
print("Usage: howdy <user> <command>") print("Usage: howdy <user> <command>")
sys.exit(1)
else: else:
print('Unknown command "' + cmd + '"') print('Unknown command "' + cmd + '"')
import cli.help import cli.help
sys.exit(1)