From ce3e1dc71204d2e536d92de65155d3b4d1393f4e Mon Sep 17 00:00:00 2001 From: Dmitry Khomutov Date: Sun, 4 Feb 2018 16:38:27 +0700 Subject: [PATCH] Added russian doc configuring-application.md. --- CHANGELOG.md | 4 +- docs/en/README.md | 2 +- ...figuring.md => configuring-application.md} | 0 docs/en/plugins/email.md | 2 +- docs/ru/configuring-application.md | 109 ++++++++++++++++++ 5 files changed, 113 insertions(+), 4 deletions(-) rename docs/en/{configuring.md => configuring-application.md} (100%) create mode 100644 docs/ru/configuring-application.md diff --git a/CHANGELOG.md b/CHANGELOG.md index ba0eeddb..2677f673 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -163,7 +163,7 @@ to [@vinpel](https://github.com/vinpel). Pull request [#141](https://github.com/ - Filtration for errors by severity and plugin. Issue [#85](https://github.com/php-censor/php-censor/issues/85). - Links to errors from summary block (Information tab). Issue [#85](https://github.com/php-censor/php-censor/issues/85). - New dashboard widget with only failed projects (See -[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring.md#dashboard-widgets)). +[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring-application.md#dashboard-widgets)). Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#131](https://github.com/php-censor/php-censor/pull/131). - Ability to call Git webhook by project name instead id. Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#132](https://github.com/php-censor/php-censor/pull/132). @@ -171,7 +171,7 @@ Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#131](https://gith ### Changed - Dashboard on the index page, now dashboard more flexible and include separated widgets (See -[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring.md#dashboard-widgets)). +[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring-application.md#dashboard-widgets)). Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#131](https://github.com/php-censor/php-censor/pull/131). ### Fixed diff --git a/docs/en/README.md b/docs/en/README.md index 963bb57f..3b71e9dc 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -10,7 +10,7 @@ Getting Started * [Run builds using cronjob](workers/cron.md) * [Adding PHP Censor Support to Your Projects](configuring_project.md) * Updating PHP Censor (See [README](../../README.md)) -* [Configuring PHP Censor](configuring.md) +* [Configuring PHP Censor](configuring-application.md) Using PHP Censor ---------------- diff --git a/docs/en/configuring.md b/docs/en/configuring-application.md similarity index 100% rename from docs/en/configuring.md rename to docs/en/configuring-application.md diff --git a/docs/en/plugins/email.md b/docs/en/plugins/email.md index 0e0d0fbe..4bb0fad7 100644 --- a/docs/en/plugins/email.md +++ b/docs/en/plugins/email.md @@ -15,7 +15,7 @@ Configuration * **template** - The template to use, options are short and long. Default is short on success and long otherwise. **Note:** _This plugin will only work if you configured email settings during installation or configured them later in -[`config.yml`](../configuring.md)._ +[`config.yml`](../configuring-application.md)._ ### Examples See [Adding PHP Censor Support to Your Projects](../configuring_project.md) for more information about how to configure plugins. diff --git a/docs/ru/configuring-application.md b/docs/ru/configuring-application.md new file mode 100644 index 00000000..9d1d431a --- /dev/null +++ b/docs/ru/configuring-application.md @@ -0,0 +1,109 @@ +Настройка PHP Censor +==================== + +Формат конфигурационного файла +------------------------------ + +Ниже приведен пример конфигурационного файла приложения: + +```yml +b8: + database: + servers: + read: + - host: localhost + port: 3306 + write: + - host: localhost + port: 3306 + type: mysql # Database type: "mysql" or "pgsql" + name: php-censor-db + username: php-censor-user + password: php-censor-password +php-censor: + language: en + per_page: 10 + url: 'http://php-censor.local' + email_settings: + from_address: 'PHP Censor ' + smtp_address: null + smtp_port: null + smtp_username: null + smtp_password: null + smtp_encryption: false + queue: + use_queue: true + host: localhost + name: php-censor-queue + lifetime: 600 + log: + rotate: true + max_files: 10 + bitbucket: + username: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + app_password: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' + comments: + commit: false # This option allow/deny to post comments to Bitbucket commit + pull_request: false # This option allow/deny to post comments to Bitbucket Pull Request + status: + commit: false # This option allow/deny to post status to Bitbucket commit + github: + token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' + comments: + commit: false # This option allow/deny to post comments to Github commit + pull_request: false # This option allow/deny to post comments to Github Pull Request + status: + commit: false # This option allow/deny to post status to Github commit + build: + remove_builds: true # This option allow/deny build cleaning + writer_buffer_size: 500 # BuildErrorWriter buffer size (count of inserts in one SQL query) + security: + disable_auth: false # This option allows/deny you to disable authentication for PHP Censor + default_user_id: 1 # Default user when authentication disabled + auth_providers: # Authentication providers + internal: + type: internal # Default provider (PHP Censor internal authentication) + ldap: + type: ldap # Your LDAP provider + data: + host: 'ldap.php-censor.local' + port: 389 + base_dn: 'dc=php-censor,dc=local' + mail_attribute: mail + dashboard_widgets: + all_projects: + side: left + last_builds: + side: right +``` + +### Настройки базы данных + +### Общие настройки + +### Почтовые настройки + +### Настройки очереди сборок + +### Настройки логирования + +### Настройки интеграции с BitBucket + +### Настройки интеграции с GitHub + +### Настройки сборки + +### Настройки безопасности + +### Настройки панели управления + +* `all_projects` - all projects build status +* `last_builds` - last builds +* `build_errors` - not successful builds + +Each widget can be located in the left or right column, use the `side` option for this: + +```yml + all_projects: + side: left +```