You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The big change in this version are tests. In addition, there are some minor changes:
* Dry Incremental update - prints what changes
* token passing per envirement variable
* possibility to use repos without login/token
Copy file name to clipboardExpand all lines: README.md
+15-3Lines changed: 15 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,14 @@ Synchronizes your data collection with GitHub and GitLab.
10
10
## Functionality
11
11
12
12
* Sync data collection from Git to DB
13
-
* Deal with Multi repository
13
+
* Deal with multiple repositories
14
14
* Incremental updates
15
+
* Works with private or public repositories
15
16
16
17
## Requirements
17
18
18
19
-[node](https://nodejs.org/en/): `v12+`
19
20
-[exist-db](https://www.exist-db.org): `v5.3.0+` (works with Version [GITSHA: 4a8124](https://github.com/eXist-db/exist#4a8124))
20
-
- Authtoken for git repository to use
21
21
22
22
## Building and Installation
23
23
@@ -56,7 +56,7 @@ An example:
56
56
<baseurl>https://api.github.com/</baseurl>
57
57
<repo>tuttle-sample-data</repo>
58
58
<owner>tuttle-sample-data</owner>
59
-
<token>XXX</token>
59
+
<token></token>
60
60
<ref>master</ref>
61
61
<hookuser>admin</hookuser>
62
62
<hookpasswd></hookpasswd>
@@ -90,6 +90,18 @@ Define the working branch of the git repository
90
90
91
91
#### hookuser & hookpasswd
92
92
93
+
#### token
94
+
95
+
If a token is specified Tuttle authenticates against GitHub or GitLab. When a token is not defined, Tuttle assumes a public repository without any authentication.
96
+
97
+
It is also possible to pass the token via an enviroment variable. The name of the variable have to be `tuttle_token_ + collection` (all dashes must be replaces by underscore). Example: `tuttle_token_tuttle_sample_data`
98
+
99
+
Be aware of the rate limits
100
+
* GitHub:
101
+
* 60 unauthenticated requests per hour
102
+
* 5,000 authenticated requests per hour
103
+
104
+
93
105
##### Create API-Keys for Github / Gitlab
94
106
95
107
At this stage of development, the API keys must be generated via the API endpoint '/git/apikey' or for a specific collection '/git/{collection}/apikey'.
0 commit comments