Simplify .htaccess and rename command line script

This commit is contained in:
Frederic Guillot
2016-11-29 20:22:41 -05:00
parent fdc4e04e87
commit 978a3c70fe
17 changed files with 91 additions and 316 deletions

View File

@@ -1,31 +1,15 @@
Интерфейс командной строки
==========================
Канборд обеспечивает простой интерфейс командной строки, которым можно воспользоваться только из Unix терминала. Эта возможность доступна только с локальной машины.
Интерфейс командной строки полезен для выполнения команд вне процессов веб сервера.
Использование[](#usage "Ссылка на этот заголовок")
---------------------------------------------------
- Откройте терминал и перейдите в директорию Канборд (например: `cd /var/www/kanboard`)
- Выполните команду `./kanboard`
<!-- -->
- Выполните команду `./cli`
Kanboard version master
@@ -107,130 +91,67 @@
user:reset-password Change user password
Доступные команды[](#available-commands "Ссылка на этот заголовок")
--------------------------------------------------------------------
### Экспорт задач в формате CSV[¶](#tasks-csv-export "Ссылка на этот заголовок")
Применение:
./kanboard export:tasks <project_id> <start_date> <end_date>
./cli export:tasks <project_id> <start_date> <end_date>
Пример:
./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
./cli export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
Данные CSV передаются в `stdout`.
### Экспорт подзадач в формате CSV[¶](#subtasks-csv-export "Ссылка на этот заголовок")
Применение:
./kanboard export:subtasks <project_id> <start_date> <end_date>
./cli export:subtasks <project_id> <start_date> <end_date>
Пример:
./kanboard export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
./cli export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
### Экспорт перемещения задач в формате CSV[¶](#task-transitions-csv-export "Ссылка на этот заголовок")
Применение:
./kanboard export:transitions <project_id> <start_date> <end_date>
./cli export:transitions <project_id> <start_date> <end_date>
Пример:
./kanboard export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
./cli export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
### Экспорт ежедневных сведений в формате CSV[¶](#export-daily-summaries-data-in-csv "Ссылка на этот заголовок")
Экспортированные данные будут выведены в стандартный вывод:
./kanboard export:daily-project-column-stats <project_id> <start_date> <end_date>
./cli export:daily-project-column-stats <project_id> <start_date> <end_date>
Пример:
./kanboard export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
./cli export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
### Отправка уведомлений для просроченных задач[¶](#send-notifications-for-overdue-tasks "Ссылка на этот заголовок")
Email сообщения будут отправлены всем пользователям, у которых включено оповещение.
./kanboard notification:overdue-tasks
./cli notification:overdue-tasks
Необязательные параметры:
- `--show`: Показывать отправку уведомлений
- `--group`: Группировать все просроченные задачи для одного пользователя (со всех проектов) на один email
- `--manager`: Посылать все просроченные задачи менеджеру (менеджерам) проекта в одном email сообщении
Вы можете просмотреть просроченные задачи с помощью параметра `--show`:
```bash
./kanboard notification:overdue-tasks --show
./cli notification:overdue-tasks --show
+-----+---------+------------+------------+--------------+----------+
| Id | Title | Due date | Project Id | Project name | Assignee |
+-----+---------+------------+------------+--------------+----------+
@@ -239,93 +160,46 @@ Email сообщения будут отправлены всем пользов
+-----+---------+------------+------------+--------------+----------+
```
### Запуск ежедневной калькуляции статистики[¶](#run-daily-project-stats-calculation "Ссылка на этот заголовок")
Эта команда считает статистику для каждого проекта:
./kanboard projects:daily-stats
./cli projects:daily-stats
Run calculation for Project #0
Run calculation for Project #1
Run calculation for Project #10
### Триггеры для задач[¶](#trigger-for-tasks)
Эта команда посылает “событие для ежедневных фоновых заданий” для всех открытых задач в каждом проекте.
./kanboard trigger:tasks
./cli trigger:tasks
Trigger task event: project_id=2, nb_tasks=1
### Сброс пароля пользователя[¶](#reset-user-password "Ссылка на этот заголовок")
./kanboard user:reset-password my_user
./cli user:reset-password my_user
Будет запрошен пароль и подтверждение. Символы не отображаются на экране.
### Удаление двухуровневой аутентификации для пользователя[¶](#remove-two-factor-authentication-for-a-user "Ссылка на этот заголовок")
./kanboard user:reset-2fa my_user
./cli user:reset-2fa my_user
### Установка плагина[¶](#install-a-plugin "Ссылка на этот заголовок")
./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip
./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip
Заметка: Установленные файлы будут иметь теже права, что и у текущего пользователя
### Удаление плагина[¶](#remove-a-plugin "Ссылка на этот заголовок")
./kanboard plugin:uninstall Budget
./cli plugin:uninstall Budget
### Обновление всех плагинов[¶](#upgrade-all-plugins "Ссылка на этот заголовок")
./kanboard plugin:upgrade
./cli plugin:upgrade
* Updating plugin: Budget Planning
* Plugin up to date: Github Authentication
[Русская документация Kanboard](http://kanboard.ru/doc/)

View File

@@ -1,7 +1,6 @@
Ежедневные фоновые задачи
=========================
Для корректной работы, Канборд должен запускать ежедневные фоновые задачи. На Unix платформах этот процесс выполнятся в `cron`.
Фоновые задачи необходимы для следующих возможностей:
@@ -16,26 +15,14 @@
Для создания фоновых задач под операционной системой Unix/Linux используются разные решения. Здесь приведен пример для Ubuntu 14.04. Для других систем процедура похожа.
Отредактируйте crontab под пользователем вашего веб сервера:
sudo crontab -u www-data -e
Пример запуска ежедневной фоновой задачи в 8 утра:
0 8 * * * cd /path/to/kanboard && ./kanboard cronjob >/dev/null 2>&1
0 8 * * * cd /path/to/kanboard && ./cli cronjob >/dev/null 2>&1
Примечание: процес выполнения фоновых задач должен иметь права доступа к вашей базе данных в случае если вы используете Sqlite. Обычно, достаточно запускать фоновую задачу под пользователем веб сервера.
[Русская документация Kanboard](http://kanboard.ru/doc/)

View File

@@ -75,6 +75,7 @@
├── assets -> ../kanboard/assets
├── doc -> ../kanboard/doc
├── cli -> ../kanboard/cli
├── favicon.ico -> ../kanboard/favicon.ico
├── index.php -> ../kanboard/index.php
├── jsonrpc.php -> ../kanboard/jsonrpc.php

View File

@@ -1,61 +1,25 @@
Переводы на другие языки (локализация)
======================================
Как перевести Канборд на новый язык?[](#how-to-translate-kanboard-to-a-new-language "Ссылка на этот заголовок")
----------------------------------------------------------------------------------------------------------------
- Переводы хранятся в директории `app/Locale`
- В этой директории есть поддиректории для разных языков, например, для русского имеется `ru_RU`, для французского - `fr_FR` и т.д.
- Переводы находятся в PHP файле, который возвращает массив с парой ключ-значение
- Ключ - оригинальный текст на английском и значение - перевод на соответсвующем языке
- **Французские переводы всегда в актуальном состоянии**
- Всегда используйте последнюю версию (branch master)
### Создание нового перевода[¶](#create-a-new-translation "Ссылка на этот заголовок")
1. Создайте новую директорию: `app/Locale/xx_XX`, например `app/Locale/fr_CA` для канадского фрацузского
2. Создайте новый файл для перевода: `app/Locale/xx_XX/translations.php`
3. Используйте как образец содержимое французского перевода (локализации) и замените значения
4. Внесите изменения в файл `app/Model/Language.php`
5. Проверьте добавленный язык на локальной версии Канборда
6. Пошлите [pull-request на Github](https://help.github.com/articles/using-pull-requests/)
@@ -63,93 +27,46 @@
Как обновить имеющийся перевод?[](#how-to-update-an-existing-translation "Ссылка на этот заголовок")
-----------------------------------------------------------------------------------------------------
1. Откройте файл перевода `app/Locale/xx_XX/translations.php`
2. Отсутсвующие переводы закоментированы - `//` и значения пустые, нужно заполнить значения и удалить коментарий
3. Проверьте внесенные изменения на локальной версии Канборда и пошлите [pull-request](https://help.github.com/articles/using-pull-requests/)
Как добавить новый текст перевода в приложение?[](#how-to-add-new-translated-text-in-the-application "Ссылка на этот заголовок")
---------------------------------------------------------------------------------------------------------------------------------
Переводы отображаются с помощью функций в исходном коде:
- `t()`: показывает текст с HTML escaping
- `e()`: показывает текст без HTML escaping
Всегда используйте английскую версию исходного кода.
Текстовые строки используют функцию `sprintf()` для замены элементов:
- `%s` используется для замены строки
- `%d` используется для замены цифры
Ознакомится с доступными форматами вы можете в [документации PHP](http://php.net/sprintf).
Как найти отсутствующие переводы в приложении?[](#how-to-find-missing-translations-in-the-applications "Ссылка на этот заголовок")
-----------------------------------------------------------------------------------------------------------------------------------
Из терминала запустите следующую команду:
./kanboard locale:compare
./cli locale:compare
Все отсутствующие и неиспользуемые переводы будут показаны на экране. Добавьте их во французскую локализацию и синхронизируйте с другими локализациями (смотрите ниже)
Как синхронизировать файлы переводов?[](#how-to-synchronize-translation-files "Ссылка на этот заголовок")
----------------------------------------------------------------------------------------------------------
В оболочке Unix запустите следующую команду:
./kanboard locale:sync
./cli locale:sync
Французский перевод используется для ссылки на другие локализации.
[Русская документация Kanboard](http://kanboard.ru/doc/)