Skip to content

Commit cb1f6f5

Browse files
committed
Updated README for configuration
1 parent 3232b81 commit cb1f6f5

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,19 @@ API to generate millipedes
66

77
## Documentation
88

9-
GET /api/\<version\>/millipede
9+
`GET /api/\<version\>/millipede`
1010
* return: a millipede
1111
* parameters:
1212
* size: provide the size of the millipede (default is 10)
1313
* reverse: true to have a reverse millipede (default is false)
1414
* comment: provide a comment to the generated millipede
15+
16+
## Configuration
17+
18+
By default MaaS looks for an optional configuration file located to `/etc/maas.cfg`.
19+
You can override this value by setting the environment variable `MAAS_CONFIG_FILE` to whatever it pleases.
20+
21+
The configuration file expected content is valid python code.
22+
23+
### Values:
24+
* `REDIS_URL`: Url to the redis server for cache purpose. Caching is optional but greatly recommended

0 commit comments

Comments
 (0)