Skip to content

Commit

Permalink
Updated README.md application parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@dabico
dabico committed Jun 16, 2023
1 parent 9543fe5 commit 5e9191f
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,16 @@ java -Dapp.crawl.tokens=<your_access_token> -jar target/ghs-application.jar

Here's a list of project-specific arguments supported by the application that you can find in the `application.properties`:
| variable name | type | default value | description |
|------------------------------|--------------------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `app.crawl.enabled` | boolean | true | Specifies if the crawling jobs are enabled on startup |
| `app.crawl.languages` | List&lt;String&gt; | See [application.properties](src/main/resources/application.properties) | A comma-separated list of language names that will be targeted during crawling |
| `app.crawl.tokens` | List&lt;String&gt; | | A comma-separated list of GitHub personal access tokens (PATs) that will be used for mining the GitHub API |
| `app.crawl.scheduling` | String | 21600000 (6h, in ms) | Crawler scheduling rate, expressed as a numeric string |
| `app.crawl.startdate` | String | 2008-01-01T00:00:00 | "Beginning of time". Basically the earliest supported date for crawling repos, if no crawl jobs were previously performed. Formatted as a yyyy-MM-ddTHH:MM:SS string. |
| `app.cleanup.enabled` | boolean | true | Specified if the job responsible for removing unavailable repositories is enabled on startup |
| `app.cleanup.scheduling` | String | 21600000 (6h, in ms) | Cleanup scheduling rate, expressed as a numeric string |
| `app.cache-evict.scheduling` | String | 21600000 (6h, in ms) | Query cache eviction scheduling rate, expressed as a numeric string |
| Variable Name | Type | Default Value | Description |
|-----------------------------------|--------------------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `app.crawl.enabled` | Boolean | true | Specifies if the crawling jobs are enabled on startup |
| `app.crawl.languages` | List&lt;String&gt; | See [application.properties](src/main/resources/application.properties) | A comma-separated list of language names that will be targeted during crawling |
| `app.crawl.tokens` | List&lt;String&gt; | | A comma-separated list of GitHub personal access tokens (PATs) that will be used for mining the GitHub API |
| `app.crawl.scheduling` | String | 21600000 (6h, in ms) | Crawler scheduling rate, expressed as a numeric string |
| `app.crawl.startdate` | String | 2008-01-01T00:00:00 | "Beginning of time". Basically the earliest supported date for crawling repos, if no crawl jobs were previously performed. Formatted as a yyyy-MM-ddTHH:MM:SS string. |
| `app.cleanup.enabled` | Boolean | true | Specified if the job responsible for removing unavailable repositories is enabled on startup |
| `app.cleanup.scheduling` | String | 21600000 (6h, in ms) | Cleanup scheduling rate, expressed as a numeric string |
| `app.statistics.suggestion-limit` | Integer | 500 | The maximum number of suggestions that will be made available to the UI autocompletion fields |
### Web UI
Expand Down

0 comments on commit 5e9191f

Please sign in to comment.