Document yaml auth for
@@ -376,6 +376,7 @@ $ gem install my_first_gem --source http://localhost:8080/gem
## Authentication
+### Environment variables
The simplest way to start Artipie with authentication is to configure single user via
environment variables:
- `ARTIPIE_USER_NAME` - user name
@@ -388,6 +389,25 @@ docker run -d -v /var/artipie:/var/artipie` -p 80:80 \
artipie/artipie:latest
```
+### Credentials settings
+
+Authentication cal also be configured with yaml credentials file:
+
+```yaml
+credentials:
+ jane:
+ pass: "plain:qwerty"
+ joe:
+ login: joe@mail.com
+ pass: "sha256:xxxxxxxxxxxxxxxxxxxxxx"
+ john:
+ pass: "sha256:xxxxxxxxxxxxxxxxxxxxxxx"
+```
+The root element `credentials` contains unique usernames mapping with the password and
+optional `login` element to override the login. Password format is `{type}:{data}`, where `type` can be
+either `plain`, which means that the password is a plain text `data` part of `pass`, or `sha256`,
+which means that password is `sha256` hashed.
+
## How to contribute
Fork the repository, make changes, and send us a
