summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 13 insertions, 3 deletions
diff --git a/README b/README
index c62d024..5fe1d93 100644
--- a/README
+++ b/README
@@ -64,9 +64,10 @@ The `lorry-controller.conf` file
--------------------------------
`lorry-controller.conf` is a JSON file containing a list of maps. Each
-map specifies another Trove, or one set of `.lorry` files. Here's an
-example that tells LC to mirror the `git.baserock.org` Trove and
-anything in the `open-source-lorries/*.lorry` files (if any exist).
+map specifies another Trove, a GitLab instance, or one set of `.lorry`
+files. Here's an example that tells LC to mirror the `git.baserock.org`
+Trove and anything in the `open-source-lorries/*.lorry` files (if any
+exist).
[
{
@@ -130,6 +131,15 @@ specifications:
(only). It should be a dictionary with the fields `username` and
`password`.
+A GitLab specification (map) makes use of the same keys as a Trove,
+however it uses an additional mandatory key:
+
+* `type: gitlab` -- specify it's a GitLab specification.
+
+* `private-token` -- the GitLab private token for a user with the
+ minimum permissions of master of any group you may wish to create
+ repositories under.
+
A Lorry specification (map) uses the following keys, all of them
mandatory: