config.yaml.example

# Application specific settings
main_app:
    servername: "pushmanager.example.com"
    port: 443
    redir_port: 80
    ssl_certfile: "/path/to/file.pem"
    ssl_keyfile: "/path/to/file.key"
    debug: False

api_app:
    servername: "pushmanager.example.com"
    port: 8843

# The strategy used for authentication. Either "ldap" or "saml".
login_strategy: "ldap"

# Only required for the saml login strategy. Defines where to find
# the configuration JSON files for python-saml.
#saml_config_folder: "saml/"

# Database connection string
db_uri: "mysql://user:password@host/database"

# effective user name/id
username: "www-data"

# Where to write out log files
log_path: "/var/log/pushmanager"

# Mappings between usernames and email addresses (for those
# which aren't identical).
aliases:
    "johndoe@example.com": "jdoe@example.com"

# Used for tornado's secure cookies
cookie_secret: "changethis"

# LDAP is the default (and for now only) authentication mechanism.
auth_ldap:
    url: "ldap://ldap.example.com:389"
    domain: "example.com"
    basedn: "CN=Users,OU=Groups,OU=Company,DC=example,DC=com"
    cert_file: "/path/to/file.crt"

# IRC channels to report to
irc:
    # nickname can be parameterized with syntax like a python format string
    nickname: "pushhamster|{pushmaster}"
    channel: "push"

mail:
    default_domain: "example.com"
    from: "no-reply+pushmaster-spam@example.com"
    # Email address to send copies of all outgoing email to
    notifyall:
        - "push-updates@example.com"
    notifyonly: []

# Credentials for XMPP notifications
xmpp:
    default_domain: "example.com"
    server: "xmpp_server"
    username: "someone@example.com"
    password: "abc123"
    notifyonly: []

# ReviewBoard instance
reviewboard:
    servername: reviewboard.mydomain.com
    username: example
    password: foobar

# Buildbot manager instance
buildbot:
    servername: buildbot.mydomain.com

# Set dynamic test tag using a REST api (http or https)
# Request's SHA will replace %SHA% and %BRANCH% will be replaced with branchname
tests_tag:
    # User-added tag that will be replaced with api result
    tag: "test-framework"
    # JSON 'tag' value from POST response of this URL will replace tag
    tag_api_endpoint: "http://example.com/api/v1/tests_tag"
    tag_api_body: '{ "sha" : "%SHA%" }'

    # If defined, tag will link to servername below and replace %ID%
    # with the 'id' field in the JSON returned by url_api
    url_api_endpoint: "http://example.com/api/v1/test_results_id"
    url_api_body: '{ "sha" : "%SHA%" }'
    # The run's ID from api will replace %ID% 
    url_tmpl: "example.com/run/%SHA%/%ID%"

    # Link template for url to results for push's branch
    # (can only replace branch, not sha or id)
    push_url_tmpl: "http://example.com/branch/%BRANCH%"
    push_test_label: "Test Runs"

# The string %TICKET% will be replaced by the ticket id
ticket_tracker_url_format: "http://server:port/path/%TICKET%"

git:
    scheme: "git"
    auth: ""
    port: ""
    servername: "git.example.com"
    gitweb_servername: "gitweb.example.com"
    main_repository: "main-repository"
    dev_repositories_dir: "devs"
    local_repo_path: "/place/to/store/on-disk/git/repos/"
    local_mirror: "/rererence/repository/for/main_repository"
    use_local_mirror: False
    conflict-threads: 1

    # A background worker tries to verify the given branch in a push
    # request by checking the SHA of the branch in the repository and
    # in DB - to see if there was already a request for the
    # change. Push requests with certain tags just modify the workflow
    # and are not associated with a git branch. We do not need to
    # verify the branch for those requests.
    exclude_from_verification: []

# Pushmanager can POST to a given URL with the data below. This
# preliminary support for webhooks is used for an internal Yelp tool
# that associates two entities with one another (e.g. linking a ticket
# with a code review).
#
# {
#   'reason': '',
#   'left_type': '',
#   'left_token': '',
#   'right_type': '',
#   'right_token': '',
#}
web_hooks:
    service_name: "Events"
    post_url: "https://eventhub.example.com/add_event"
    get_request_url: "https://eventhub.example.com/event_with_id"


# Pushmanager has a javascript bookmarklet to make verifiying a set of
# urls manually. This is generally the last step after a successful
# push.
check_sites_bookmarklet:
    domain_name: "example"
    urls:
        - 'www.example.com/page1/'
        - 'm.example.com/'
        - 'www.example.com/search?q=thing'
        - 'www.example.com/search?id=production_id'
    substitutions:
        - 'production_id' : 'non_production_id'

tornado:
   num_workers: 4


# Upon completion of a push, Pushmanager can optionally display a button to fill out a survey.
# If this is not defined, no button to a survey is displayed.
# push_survey_url: 'https://examplesurvey'