Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emersonelectricco/lowball-arangodb-authdb
An Authentication Database for lowball that uses ArangoDB
https://github.com/emersonelectricco/lowball-arangodb-authdb
arangodb flask lowball
Last synced: 21 days ago
JSON representation
An Authentication Database for lowball that uses ArangoDB
- Host: GitHub
- URL: https://github.com/emersonelectricco/lowball-arangodb-authdb
- Owner: EmersonElectricCo
- License: apache-2.0
- Created: 2021-05-06T19:17:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-09T14:16:24.000Z (over 3 years ago)
- Last Synced: 2024-11-21T10:37:16.046Z (about 1 month ago)
- Topics: arangodb, flask, lowball
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lowball-arangodb-authdb
A simple Authentication Database implementation of the specification for [Lowball](https://github.com/EmersonElectricCo/lowball)
`AuthDatabase` provider leveraging ArangoDB.
## Installation
lowball arangodb authdb has been tested to work with only Python 3.6+ and with ArangoDB Versions 3.4-3.7
```
pip install lowball-arangodb-authdb
```
## Configuration
In the lowball configuration's `auth_db` section, the following fields can be set.
These are the default values, and if you do not wish to change them, they do not need to appear in the configuration.
```yaml
...
auth_db:
url: "http://127.0.0.1"
port: 8529
user: "root"
password:
verify: true
database_name: "lowball_authdb"
collection_name: "authentication_tokens"
...
```
__Field Descriptions__
- url - the full url to the server, including http or https
- port - the port to connect with
- user - the user to authenticate to the arango instance
- password - the password for the user
- verify - Irrelevant for non-TLS connections, true to validate certificates, false to skip validation.
Can also be set to a path to a certificate file that will be used for validation.
- database_name - the name to give the database which will hold the collection storing the tokens
- collection_name - the name to give the collection to hold the tokens.
## Example Usage
```python
from lowball import Lowball, config_from_file
from lowball_arangodb_authdb import LowballArangoDBAuthDB
lowball_config = config_from_file("/path/to/config.yaml")
lowball = Lowball(config=lowball_config, auth_database=LowballArangoDBAuthDB)
```
__Notes__
The authentication database implementation expects to have a collection to itself. Documents it attempts to
load which do not match the `Token` specification will be deleted.
Multiple Lowball Applications should have no issue interacting with the same ArangoDB backend.