https://github.com/jprjr/htpasswd-auth-server
A lazy development stand-in for ldap-auth-server
https://github.com/jprjr/htpasswd-auth-server
Last synced: 3 months ago
JSON representation
A lazy development stand-in for ldap-auth-server
- Host: GitHub
- URL: https://github.com/jprjr/htpasswd-auth-server
- Owner: jprjr
- License: mit
- Created: 2016-11-15T22:52:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-06T21:06:25.000Z (almost 8 years ago)
- Last Synced: 2025-01-24T21:14:04.199Z (5 months ago)
- Language: Lua
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# htpasswd-auth-server
This is a small server for use with nginx's [auth_request module](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html).
This is really just an overkill way of launching nginx with an htpasswd
file. It's mostly used as a development stand-in for [ldap-auth-server](https://github.com/jprjr/ldap-auth-server).
It requires any version of nginx, Lua, and the following lua modules:
* luaposix
* etlua
* luafilesystem
* lbase64
* lecho
## install + use
Just git clone this repository somewhere.
From there, you can install the needed lua modules however you regularly do.
If you install them into a folder named `lua_modules`, then the script
`bin/htpasswd-auth-server` will use (and *only* use) modules found under that
folder. For example, after cloning you could run:
```bash
luarocks --tree lua_modules install luaposix
luarocks --tree lua_modules install etlua
luarocks --tree lua_modules install luafilesystem
luarocks --tree lua_modules install lbase64
luarocks --tree lua_modules install lecho
```
Make a copy of `etc/config.lua.example` to `etc/config.lua` and edit
as-needed, then run `bin/htpasswd-auth-server run` to launch the server.
By default, all temp files, compiled config files, etc are placed at
`$HOME/.htpasswd-auth-server` - this can be changed by setting the `work_dir`
variable in `etc/config.lua`
You can also use `bin/htpasswd-auth-server` to edit/update the htpasswd file.
Just run `bin/htpasswd-auth-server add` and you'll be prompted to enter a
username and password.
To run as a service, there's an example systemd unit file at
`misc/ldap-auth-server.service`:
```bash
sudo cp misc/htpasswd-auth-server.service /etc/systemd/system/htpasswd-auth-server.service
# edit /etc/systemd/system/htpasswd-auth-server.service as needed
sudo systemctl daemon-reload
sudo systemctl enable htpasswd-auth-server.service
sudo systemctl start htpasswd-auth-server.service
```
## License
Released under an MIT-style license. See the file `LICENSE` for details.
This contains a copy of md5.lua from https://github.com/kikito/md5.lua (as
`lib/md5.lua`) - this is also MIT-licensed. A copy of the license can
be found in `lib/md5.lua`