jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/369406 )
Change subject: Update config documentation in README ...................................................................... Update config documentation in README Change-Id: If41c8005fffba97210bbc346cfc13dd62114b16e --- M README 1 file changed, 15 insertions(+), 4 deletions(-) Approvals: Mepps: Looks good to me, approved jenkins-bot: Verified diff --git a/README b/README index 3b23a55..5eb4492 100644 --- a/README +++ b/README @@ -1,15 +1,26 @@ +SmashPig payments library + This project uses Composer [https://getcomposer.org] to manage dependencies. Upon first install and any upgrade please run composer install. -Default configuration values are located in config/main.yaml. These are -overridden by values in /etc/smashpig/main.yaml, then by values in -~/.smashpig/main.yaml. +SmashPig uses two types of configuration files. + +Global configuration files define settings shared across all payment providers, +including database and queue settings. Default global configuration values are +located in config/main.yaml. These are overridden by values in +/etc/smashpig/main.yaml, then by values in ~/.smashpig/main.yaml. + +Provider configurations files contain settings which may differ between payment +providers, such as account credentials and HTTP request settings. Defaults are +in config/provider-defaults.yaml. They are overridden in a similar cascade by +the same file in /etc/smashpig and ~/.smashpig, then overridden by settings in +main.yaml in subdirectories named for the relevant payment processor. Command-line maintenance scripts have some common options: --help --memory-limit overrides the limit specified in php.ini --config-path specifies a top-priority override configuration file path - --config-node specifies which configuration node to use + --config-node specifies which processor-specific configuration to use -- 3rd Party Licences -- The favicon is licenced under CC Attribution. http://creativecommons.org/licenses/by/3.0/legalcode -- To view, visit https://gerrit.wikimedia.org/r/369406 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: If41c8005fffba97210bbc346cfc13dd62114b16e Gerrit-PatchSet: 2 Gerrit-Project: wikimedia/fundraising/SmashPig Gerrit-Branch: master Gerrit-Owner: Ejegg <ej...@ejegg.com> Gerrit-Reviewer: Mepps <me...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
