Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dokku/dokku-http-auth
dokku plugin that gives the ability to manage HTTP basic auth for an application
https://github.com/dokku/dokku-http-auth
auth dokku dokku-plugin nginx paas
Last synced: 3 months ago
JSON representation
dokku plugin that gives the ability to manage HTTP basic auth for an application
- Host: GitHub
- URL: https://github.com/dokku/dokku-http-auth
- Owner: dokku
- License: mit
- Created: 2015-03-16T22:51:31.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T17:28:15.000Z (7 months ago)
- Last Synced: 2024-10-30T00:56:03.657Z (3 months ago)
- Topics: auth, dokku, dokku-plugin, nginx, paas
- Language: Shell
- Homepage:
- Size: 47.9 KB
- Stars: 85
- Watchers: 3
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - dokku/dokku-http-auth - dokku plugin that gives the ability to manage HTTP basic auth for an application (others)
README
# dokku-http-auth
dokku-http-auth is a plugin for [dokku][dokku] that gives the ability to enable or disable HTTP authentication for an application.
## Requirements
`mkpasswd` from the `whois` package is required to generate secure hash (SHA-512) from provided passwords. It will be installed via `apt-get` when calling `dokku plugins-install`.
## Installation
```sh
# dokku 0.4+
$ dokku plugin:install https://github.com/dokku/dokku-http-auth.git
```
## Commands
```
$ dokku http-auth:help
http-auth:add-user Add basic auth user to app
http-auth:add-allowed-ip
Add allowed IP to basic auth bypass for an app
http-auth:disable Disable HTTP auth for app
http-auth:enable Enable HTTP auth for app
http-auth:remove-allowed-ip Remove allowed IP from basic auth bypass for an app
http-auth:remove-user Remove basic auth user from app
http-auth:report [] [] Displays an http-auth report for one or more apps
http-auth:show-config Display app http-auth config
```
## Usage
### Enabling HTTP Auth
The `http-auth:enable` command can be used to enable HTTP Auth for an app.
```shell
dokku http-auth:enable node-js-app
```
```
-----> Enabling HTTP auth for node-js-app...
! Skipping user initialization
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating https nginx.conf
Enabling HSTS
Reloading nginx
Done
```
A user/password combination can also be specified when enabling HTTP Auth.
```shell
dokku http-auth:enable node-js-app username password
```
```
-----> Enabling HTTP auth for node-js-app...
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating https nginx.conf
Enabling HSTS
Reloading nginx
Done
```
### Adding users
Individual user/password combinations can be added at any point in time via the `http-auth:add-user` command. Specifying the same user twice will override the first instance of the user, even if the password is the same.
```shell
dokku http-auth:add-user node-js-app username password
```
```
-----> Adding username to basic auth list
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating https nginx.conf
Enabling HSTS
Reloading nginx
```
### Removing users
A user can be removed via the `http-auth:remove-user` command. This command will always reload nginx, even if the user does not exist.
```shell
dokku http-auth:remove-user node-js-app username
```
```
-----> Removing username from basic auth list
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating https nginx.conf
Enabling HSTS
Reloading nginx
```
### Limiting access to specific IP Addresses
> See the [Nginx Documentation](https://nginx.org/en/docs/stream/ngx_stream_access_module.html) for more information on how this works
Access can be allowed to only a specified set of IP Addresses, CIDR Blocks, or UNIX-domain sockets via the `http-auth:add-allowed-ip` command. This is used in conjunction with the basic auth support.
```shell
dokku http-auth:add-allowed-ip node-js-app 127.0.0.1
````
```
-----> Adding 127.0.0.1 to allowed ip list
-----> Ensuring network configuration is in sync for node-js-app
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating https nginx.conf
Enabling HSTS
Reloading nginx
```
The specified IP address can be removed via the `http-auth:remove-allowed-ip` command.
```shell
dokku http-auth:remove-allowed-ip node-js-app 127.0.0.1
````
```
-----> Removing 127.0.0.1 from allowed ip list
-----> Ensuring network configuration is in sync for node-js-app
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating https nginx.conf
Enabling HSTS
Reloading nginx
```
### Viewing http auth config
The nginx `http-auth.conf` file can be viewed via the `http-auth:show-config` command. This command will _not_ output the `htaccess` file.
```shell
dokku http-auth:show-config node-js-app username
```
```
auth_basic "Restricted";
auth_basic_user_file /home/dokku/node-js-app/htpasswd;
```
### Displaying http auth reports for an app
You can get a report about the app's http-auth status using the `http-auth:report` command:
```shell
# dokku http-auth:report node-js-app
```
```
=====> node-js-app http-auth information
Http auth enabled: true
Http auth allowed ips: 127.0.0.1
Http auth users: root username
```
You can pass flags which will output only the value of the specific information you want. For example:
```shell
dokku http-auth:report node-js-app --http-auth-enabled
```
## License
This plugin is released under the MIT license. See the file [LICENSE](LICENSE).
[dokku]: https://github.com/dokku/dokku