https://github.com/stackstorm/st2-auth-backend-flat-file
Authentication backend for StackStorm which stores authentication information in a htpasswd compatible file on disk.
https://github.com/stackstorm/st2-auth-backend-flat-file
Last synced: 9 months ago
JSON representation
Authentication backend for StackStorm which stores authentication information in a htpasswd compatible file on disk.
- Host: GitHub
- URL: https://github.com/stackstorm/st2-auth-backend-flat-file
- Owner: StackStorm
- License: apache-2.0
- Created: 2015-08-25T16:07:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T15:29:47.000Z (about 1 year ago)
- Last Synced: 2025-03-27T01:12:41.305Z (10 months ago)
- Language: Python
- Size: 46.9 KB
- Stars: 0
- Watchers: 21
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flat file authentication plugin for StackStorm Community edition
[](https://travis-ci.org/StackStorm/st2-auth-backend-flat-file) [](http://webchat.freenode.net/?channels=stackstorm)
Flat file backend supports reading credentials from an Apache HTTPd htpasswd formatted file. To
manage this file you can use [htpasswd](https://httpd.apache.org/docs/2.2/programs/htpasswd.html)
utility which comes with a standard Apache httpd distribution or by installing apache2-utils
package on Ubuntu / Debian.
### Configuration Options
| option | required | default | description |
|-----------|----------|---------|------------------------------------------------------------|
| file_path | yes | | Path to the file containing credentials |
### Configuration Example
Please refer to the authentication section in the StackStorm
[documentation](http://docs.stackstorm.com) for basic setup concept. The
following is an example of the auth section in the StackStorm configuration file for the flat-file
backend.
```ini
[auth]
mode = standalone
backend = flat_file
backend_kwargs = {"file_path": "/path/to/.htpasswd"}
enable = True
use_ssl = True
cert = /path/to/ssl/cert/file
key = /path/to/ssl/key/file
logging = /path/to/st2auth.logging.conf
api_url = https://myhost.example.com:9101
debug = False
```
The following is an sample htpasswd command to generate a password file with a user entry.
```
htpasswd -cs /path/to/.htpasswd stark
```
## Copyright, License, and Contributors Agreement
Copyright 2015 StackStorm, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in
compliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file,
or at: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
By contributing you agree that these contributions are your own (or approved by your employer) and
you grant a full, complete, irrevocable copyright license to all users and developers of the
project, present and future, pursuant to the license of the project.