document repo perms
@@ -71,6 +71,14 @@ We recommend you read the "Architecture" section in our
[White Paper](https://github.com/artipie/white-paper) to fully
understand how Artipie is designed.
+## Contents
+
+- [Multitenancy](#multitenancy)
+- [Repository permissions](#repository-permissions)
+- [Storage configuration](#storage-configuration)
+- [Metrics](#metrics)
+- [Artipie REST API](#artipie-rest-api)
+
## Multitenancy
You may want to run Artipie for your company, which has a few teams.
@@ -115,18 +123,33 @@ docker run -d -v /var/artipie:/var/artipie` -p 80:80 \
artipie/artipie:latest
```
-## Metrics
-
-You may enable some basic metrics collecting and periodic publishing to application log
-by adding `metrics` to `meta` section of global configuration file `/etc/artipie.yml`:
+## Repository permissions
+Permissions for repository operations can granted in the repo configuration file:
```yaml
-meta:
- metrics:
- type: log # Metrics type, for now only `log` type is supported
- interval: 5 # Publishing interval in seconds, default value is 5
+repo:
+ ...
+ permissions:
+ jane:
+ - read
+ - write
+ admin:
+ - "*"
+ /readers:
+ - read
```
+All repositories support `read` and `write` operations, files repository also supports `delete` operation.
+
+Group names should start with `/`, is the example above `read` operation is granted for `readers` group
+and every user within the group can read from the repository, `read` and `write` operations are granted to user named `jane`.
+We also support asterisk wildcard for "any operation" or "any user", user `admin` in the example above
+can perform any operation in the repository.
+
+## Storage configuration
+
+TBW
+
## Single repository on port
Artipie repositories may run on separate ports if configured.
@@ -146,6 +169,18 @@ repo:
*NOTE: Artipie scans repositories for port configuration only on start,
so server requires restart in order to apply changes made in runtime.*
+## Metrics
+
+You may enable some basic metrics collecting and periodic publishing to application log
+by adding `metrics` to `meta` section of global configuration file `/etc/artipie.yml`:
+
+```yaml
+meta:
+ metrics:
+ type: log # Metrics type, for now only `log` type is supported
+ interval: 5 # Publishing interval in seconds, default value is 5
+```
+
## Artipie REST API
Artipie provides a set of APIs to manage repositories and users. The current APIs are fully documented [here](./REST_API.md).
