Skip to content

Commit

Permalink
docs: add configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bethesque committed Aug 3, 2021
1 parent 563eecd commit 8a67949
Show file tree
Hide file tree
Showing 3 changed files with 619 additions and 0 deletions.
300 changes: 300 additions & 0 deletions docs/CONFIGURATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,300 @@
# Pact Broker Configuration


<br/>

## Logging

<hr/>


### log_level

The application log level

**Required:** false<br/>
**Default:** `info`<br/>
**Allowed values:** `debug`, `info`, `warn`, `error`, `fatal`<br/>

### log_format

The application log format

**Required:** false<br/>
**Default:** `default`<br/>
**Allowed values:** `default`, `json`, `color`<br/>
**More information:** https://github.com/rocketjob/semantic_logger/tree/master/lib/semantic_logger/formatters<br/>

<br/>

## TODO

<hr/>


### basic_auth_enabled



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### basic_auth_username



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### basic_auth_password



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### basic_auth_read_only_username



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### basic_auth_read_only_password



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### allow_public_read



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### public_heartbeat



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### log_dir



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### log_stream



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### log_level



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### log_format



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### warning_error_class_names



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### hide_pactflow_messages



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### webhook_retry_schedule



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### webhook_http_method_whitelist



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### webhook_http_code_success



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### webhook_scheme_whitelist



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### webhook_host_whitelist



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### disable_ssl_verification



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### user_agent



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### port



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### base_url



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### base_urls



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### use_hal_browser



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### enable_diagnostic_endpoints



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### use_rack_protection



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### badge_provider_mode



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### enable_public_badge_access



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### shields_io_base_url



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### use_case_sensitive_resource_names



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### order_versions_by_date



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### base_equality_only_on_content_that_affects_verification_results



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### check_for_potential_duplicate_pacticipant_names



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### create_deployed_versions_for_tags



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### use_first_tag_as_branch



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### use_first_tag_as_branch_time_limit



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### semver_formats



**Required:** false<br/>
**Allowed values:** `todo`<br/>

### features



**Required:** false<br/>
**Allowed values:** `todo`<br/>

Loading

0 comments on commit 8a67949

Please sign in to comment.