Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Add configuration instructions #70

Open
nhooey opened this issue Feb 23, 2022 · 4 comments
Open

Documentation: Add configuration instructions #70

nhooey opened this issue Feb 23, 2022 · 4 comments

Comments

@nhooey
Copy link

nhooey commented Feb 23, 2022

The documentation could use some configuration instructions, like defining the host and port of the ArangoDB instance.

Having configuration for timeouts would be great as well, including defaults.

@darkfrog26
Copy link
Contributor

I agree this should be documented better, but this is already configurable: https://github.com/outr/scarango/blob/master/driver/src/main/scala/com/outr/arango/core/ArangoDBConfig.scala#L10

When you instantiate the Graph you can optionally supply your own ArangoDBConfig, or you can just define those configuration items via Profig. In the latter case, you can define a config.json file like:

{
  "arangodb": {
    "username": "root",
    "password": "password"
  }
}

Or you can specify via environment variables:
ARANGODB_USERNAME=root
ARANGODB_PASSWORD=password
Or you can pass in command-line arguments:
myApp -arangodb.username=root -arangodb.password=password

If you're up to creating a PR to add this to the README that would certainly be welcome.

@darkfrog26
Copy link
Contributor

@nhooey I'm closing this for lack of response. Please open a new ticket if you need further assistance.

@nhooey
Copy link
Author

nhooey commented Mar 16, 2022

The documentation still doesn't have configuration instructions.
I'm not sure why it makes sense to close the ticket because I didn't respond.

@darkfrog26
Copy link
Contributor

That's fair.

@darkfrog26 darkfrog26 reopened this Mar 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants