summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBen Brown <ben.brown@codethink.co.uk>2016-04-18 16:04:52 +0100
committerVLetrmx <richardipsum@fastmail.co.uk>2016-06-17 18:40:17 +0000
commit4947e78942bf325ed85645876f0352eb3cd24e5e (patch)
tree758aa3b242afb93bc55f3a69705ba2a2ecb6124d /README
parent7587a31568f960d41c62a8486442bd6d9ea42ba0 (diff)
downloadlorry-controller-4947e78942bf325ed85645876f0352eb3cd24e5e.tar.gz
Add support for lorrying from a Gitlab server
Change-Id: I2bb0aaf428e331a0bcd5a1e3111d4c7bca4afede
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: