mirror of
https://github.com/boltgolt/howdy.git
synced 2024-09-19 09:51:19 +02:00
Small fixes for 2.3.0 release
This commit is contained in:
parent
f604ad0aa0
commit
53b850ce57
3 changed files with 10 additions and 10 deletions
16
README.md
16
README.md
|
@ -4,13 +4,13 @@ Windows Hello™ style authentication for Linux. Use your built-in IR emitters a
|
|||
|
||||
Using the central authentication system (PAM), this works everywhere you would otherwise need your password: Login, lock screen, sudo, su, etc.
|
||||
|
||||
### Installation
|
||||
## Installation
|
||||
|
||||
Howdy is currently available for Ubuntu/Debian and Arch Linux. If you’re interested in packaging Howdy for your distro, don’t hesitate to open an issue.
|
||||
|
||||
**Note:** The build of dlib can hang on 100% for over a minute, give it time.
|
||||
|
||||
##### Ubuntu (apt)
|
||||
### Ubuntu (apt)
|
||||
|
||||
Run the installer by pasting (`ctrl+shift+V`) the following commands into the terminal one at a time:
|
||||
|
||||
|
@ -22,13 +22,13 @@ sudo apt install howdy
|
|||
|
||||
This will guide you through the installation.
|
||||
|
||||
##### Arch Linux
|
||||
### Arch Linux
|
||||
|
||||
Install the `howdy` package from the AUR. For AUR installation instructions, take a look at this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).
|
||||
|
||||
You will need to do some additional configuration steps. Please read the [ArchWiki entry](https://wiki.archlinux.org/index.php/Howdy) for more information.
|
||||
|
||||
### Setup
|
||||
## Setup
|
||||
|
||||
After installation, you need to let Howdy learn your face. Run `sudo howdy add` to add a face model.
|
||||
|
||||
|
@ -36,7 +36,7 @@ If nothing went wrong we should be able to run sudo by just showing your face. O
|
|||
|
||||
If you're curious you can run `sudo howdy config` to open the central config file and see the options Howdy has. On most systems this will open the nano editor, where you have to press `ctrl`+`x` to save your changes.
|
||||
|
||||
### CLI
|
||||
## CLI
|
||||
|
||||
The installer adds a `howdy` command to manage face models for the current user. Use `howdy --help` or `man howdy` to list the available options.
|
||||
|
||||
|
@ -55,17 +55,17 @@ howdy [-U user] [-y] command [argument]
|
|||
| `remove` | Remove a specific model for an user |
|
||||
| `test` | Test the camera and recognition methods |
|
||||
|
||||
### Contributing [![](https://img.shields.io/travis/boltgolt/howdy/dev.svg?label=dev%20build)](https://github.com/boltgolt/howdy/tree/dev) [![](https://img.shields.io/github/issues-raw/boltgolt/howdy/enhancement.svg?label=feature+requests&colorB=4c1)](https://github.com/boltgolt/howdy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||||
## Contributing [![](https://img.shields.io/travis/boltgolt/howdy/dev.svg?label=dev%20build)](https://github.com/boltgolt/howdy/tree/dev) [![](https://img.shields.io/github/issues-raw/boltgolt/howdy/enhancement.svg?label=feature+requests&colorB=4c1)](https://github.com/boltgolt/howdy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||||
|
||||
You can contribute in many ways. The easiest are reporting bugs and opening github issues for features you'd like to see in howdy. Code contributions are also very welcome.
|
||||
|
||||
### 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.
|
||||
|
||||
If you encounter an error that hasn't been reported yet, don't be afraid to open a new issue.
|
||||
|
||||
### A note on security
|
||||
## A note on security
|
||||
|
||||
This script is in no way as secure as a password and will never be. Although it's harder to fool than normal face recognition, a person who looks similar to you or well-printed photo of you could be enough to do it.
|
||||
|
||||
|
|
2
debian/control
vendored
2
debian/control
vendored
|
@ -10,6 +10,6 @@ Package: howdy
|
|||
Homepage: https://github.com/boltgolt/howdy
|
||||
Architecture: all
|
||||
Depends: ${misc:Depends}, git, python3, python3-pip, python3-dev, python3-setuptools, build-essential, libpam-python, fswebcam, libopencv-dev, python-opencv, cmake
|
||||
Description: Howdy: Windows Hello style authentication for Ubuntu.
|
||||
Description: Howdy: Windows Hello style authentication for Linux.
|
||||
Use your built-in IR emitters and camera in combination with face recognition
|
||||
to prove who you are.
|
||||
|
|
2
debian/howdy.1
vendored
2
debian/howdy.1
vendored
|
@ -1,7 +1,7 @@
|
|||
.\" Please adjust this date whenever revising the manpage.
|
||||
.TH HOWDY 1 "April 9, 2018" "Howdy help" "User Commands"
|
||||
.SH NAME
|
||||
howdy \- Windows Hello style authentication for Ubuntu
|
||||
howdy \- Windows Hello style authentication for Linux
|
||||
.SH DESCRIPTION
|
||||
Howdy IR face recognition implements a PAM module to use your face as a authentication method.
|
||||
.SS "Usage:"
|
||||
|
|
Loading…
Reference in a new issue