Skip to content

Commit 33b6711

Browse files
committed
Update README documentation
1 parent 26401e4 commit 33b6711

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# Flat file authentication plugin for StackStorm Community edition
22

3-
[![Build Status](https://api.travis-ci.org/StackStorm/st2-auth-backend-flat-file.svg?branch=master)](https://travis-ci.org/StackStorm/st2-auth-backend-flat-file) [![IRC](https://img.shields.io/irc/%23stackstorm.png)](http://webchat.freenode.net/?channels=stackstorm)
3+
[![Tox CI](https://github.com/StackStorm/st2-auth-backend-flat-file/actions/workflows/tox.yaml/badge.svg)](https://github.com/StackStorm/st2-auth-backend-flat-file/actions/workflows/tox.yaml)
44

5-
Flat file backend supports reading credentials from an Apache HTTPd htpasswd formatted file. To
6-
manage this file you can use [htpasswd](https://httpd.apache.org/docs/2.2/programs/htpasswd.html)
7-
utility which comes with a standard Apache httpd distribution or by installing apache2-utils
8-
package on Ubuntu / Debian.
5+
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.
96

107
### Configuration Options
118

@@ -15,10 +12,7 @@ package on Ubuntu / Debian.
1512

1613
### Configuration Example
1714

18-
Please refer to the authentication section in the StackStorm
19-
[documentation](http://docs.stackstorm.com) for basic setup concept. The
20-
following is an example of the auth section in the StackStorm configuration file for the flat-file
21-
backend.
15+
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.
2216

2317
```ini
2418
[auth]
@@ -34,14 +28,15 @@ api_url = https://myhost.example.com:9101
3428
debug = False
3529
```
3630

37-
The following is an sample htpasswd command to generate a password file with a user entry.
31+
The following is an example htpasswd command to generate a password file with a user entry. You should be using no other hashing algorithm than *bcrypt* as it is consider the only secure hashing algorithm amoung all the algorithms supported by htpasswd.
3832

3933
```
40-
htpasswd -cs /path/to/.htpasswd stark
34+
htpasswd -cB /path/to/.htpasswd stark
4135
```
4236

4337
## Copyright, License, and Contributors Agreement
4438

39+
Copyright 2025 StackStorm, Inc.
4540
Copyright 2015 StackStorm, Inc.
4641

4742
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in

0 commit comments

Comments
 (0)