Convert Markdown files to RST

garrettboone · Apr 1, 2018 · d93289d · d93289d
commit d93289d
Show file tree

Hide file tree

Showing 200 changed files with 15,525 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+build
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2018 Frédéric Guillot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Kanboard
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+Kanboard's Documentation
+========================
+
+This documentation is generated with Sphinx and pushed automatically on [Read the Docs](https://readthedocs.org/).
+
+How to generate the documentation locally?
+------------------------------------------
+
+Run `make clean html` and open the file `build/html/index.html` in your browser.
diff --git a/make.bat b/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=Kanboard
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/source/_static/2fa.png b/source/_static/2fa.png
diff --git a/source/_static/add-subtask-shortcut.png b/source/_static/add-subtask-shortcut.png
diff --git a/source/_static/add-subtask.png b/source/_static/add-subtask.png
diff --git a/source/_static/add_new_restriction.png b/source/_static/add_new_restriction.png
diff --git a/source/_static/apple-calendar-add-subscription.png b/source/_static/apple-calendar-add-subscription.png
diff --git a/source/_static/apple-calendar-edit-subscription.png b/source/_static/apple-calendar-edit-subscription.png
diff --git a/source/_static/application-settings.png b/source/_static/application-settings.png
diff --git a/source/_static/automatic-action-creation.png b/source/_static/automatic-action-creation.png
diff --git a/source/_static/average-lead-cycle-time.png b/source/_static/average-lead-cycle-time.png
diff --git a/source/_static/average-time-spent-into-each-column.png b/source/_static/average-time-spent-into-each-column.png
diff --git a/source/_static/board-collapsed-mode.png b/source/_static/board-collapsed-mode.png
diff --git a/source/_static/board-compact-mode.png b/source/_static/board-compact-mode.png
diff --git a/source/_static/board-expanded-mode.png b/source/_static/board-expanded-mode.png
diff --git a/source/_static/board-hide-show-column.png b/source/_static/board-hide-show-column.png
diff --git a/source/_static/board-settings.png b/source/_static/board-settings.png
diff --git a/source/_static/board-task-limit.png b/source/_static/board-task-limit.png
diff --git a/source/_static/board-view.png b/source/_static/board-view.png
diff --git a/source/_static/burndown-chart.png b/source/_static/burndown-chart.png
diff --git a/source/_static/calendar-settings.png b/source/_static/calendar-settings.png
diff --git a/source/_static/cfd.png b/source/_static/cfd.png
diff --git a/source/_static/closing-tasks.png b/source/_static/closing-tasks.png
diff --git a/source/_static/custom-filter-creation.png b/source/_static/custom-filter-creation.png
diff --git a/source/_static/custom-filter-dropdown.png b/source/_static/custom-filter-dropdown.png
diff --git a/source/_static/custom_roles.png b/source/_static/custom_roles.png
diff --git a/source/_static/dropdown-screenshot.png b/source/_static/dropdown-screenshot.png
diff --git a/source/_static/example-restriction-task-creation.png b/source/_static/example-restriction-task-creation.png
diff --git a/source/_static/example-restriction-task-drag-and-drop.png b/source/_static/example-restriction-task-drag-and-drop.png
diff --git a/source/_static/example-restriction-task-status-blocked.png b/source/_static/example-restriction-task-status-blocked.png
diff --git a/source/_static/example-restriction-task-status.png b/source/_static/example-restriction-task-status.png
diff --git a/source/_static/example-restrictions.png b/source/_static/example-restrictions.png
diff --git a/source/_static/google-calendar-add-subscription.png b/source/_static/google-calendar-add-subscription.png
diff --git a/source/_static/groups-management.png b/source/_static/groups-management.png
diff --git a/source/_static/hide-column.png b/source/_static/hide-column.png
diff --git a/source/_static/internal-task-links.png b/source/_static/internal-task-links.png
diff --git a/source/_static/link-label-creation.png b/source/_static/link-label-creation.png
diff --git a/source/_static/link-labels.png b/source/_static/link-labels.png
diff --git a/source/_static/list-view.png b/source/_static/list-view.png
diff --git a/source/_static/menu-close-task.png b/source/_static/menu-close-task.png
diff --git a/source/_static/new-private-project.png b/source/_static/new-private-project.png
diff --git a/source/_static/new-project.png b/source/_static/new-project.png
diff --git a/source/_static/new-user.png b/source/_static/new-user.png
diff --git a/source/_static/new_custom_role.png b/source/_static/new_custom_role.png
diff --git a/source/_static/new_restriction.png b/source/_static/new_restriction.png
diff --git a/source/_static/notifications.png b/source/_static/notifications.png
diff --git a/source/_static/project-automatic-action-step1.png b/source/_static/project-automatic-action-step1.png
diff --git a/source/_static/project-automatic-action-step2.png b/source/_static/project-automatic-action-step2.png
diff --git a/source/_static/project-automatic-action-step3.png b/source/_static/project-automatic-action-step3.png
diff --git a/source/_static/project-automatic-actions.png b/source/_static/project-automatic-actions.png
diff --git a/source/_static/project-creation-form.png b/source/_static/project-creation-form.png
diff --git a/source/_static/project-creation-link.png b/source/_static/project-creation-link.png
diff --git a/source/_static/project-disable-sharing.png b/source/_static/project-disable-sharing.png
diff --git a/source/_static/project-edition.png b/source/_static/project-edition.png
diff --git a/source/_static/project-enable-sharing.png b/source/_static/project-enable-sharing.png
diff --git a/source/_static/project-nobody-allowed.png b/source/_static/project-nobody-allowed.png
diff --git a/source/_static/project-permissions.png b/source/_static/project-permissions.png
diff --git a/source/_static/project-remove.png b/source/_static/project-remove.png
diff --git a/source/_static/project-settings.png b/source/_static/project-settings.png
diff --git a/source/_static/project-view.png b/source/_static/project-view.png
diff --git a/source/_static/recurring-tasks.png b/source/_static/recurring-tasks.png
diff --git a/source/_static/restrictions.png b/source/_static/restrictions.png
diff --git a/source/_static/show-column.png b/source/_static/show-column.png
diff --git a/source/_static/subtask-status-done.png b/source/_static/subtask-status-done.png
diff --git a/source/_static/subtask-status-inprogress.png b/source/_static/subtask-status-inprogress.png
diff --git a/source/_static/subtask-time-tracking.png b/source/_static/subtask-time-tracking.png
diff --git a/source/_static/subtask-timer.png b/source/_static/subtask-timer.png
diff --git a/source/_static/subtask-user-restriction.png b/source/_static/subtask-user-restriction.png
diff --git a/source/_static/swimlane-configuration.png b/source/_static/swimlane-configuration.png
diff --git a/source/_static/swimlanes-configuration.png b/source/_static/swimlanes-configuration.png
diff --git a/source/_static/swimlanes.png b/source/_static/swimlanes.png
diff --git a/source/_static/tags-board.png b/source/_static/tags-board.png
diff --git a/source/_static/tags-global.png b/source/_static/tags-global.png
diff --git a/source/_static/tags-projects.png b/source/_static/tags-projects.png
diff --git a/source/_static/tags-search.png b/source/_static/tags-search.png
diff --git a/source/_static/tags-task.png b/source/_static/tags-task.png
diff --git a/source/_static/task-creation-board.png b/source/_static/task-creation-board.png
diff --git a/source/_static/task-creation-form.png b/source/_static/task-creation-form.png
diff --git a/source/_static/task-distribution.png b/source/_static/task-distribution.png
diff --git a/source/_static/task-duplication-another-project.png b/source/_static/task-duplication-another-project.png
diff --git a/source/_static/task-duplication.png b/source/_static/task-duplication.png
diff --git a/source/_static/task-lead-cycle-time.png b/source/_static/task-lead-cycle-time.png
diff --git a/source/_static/task-links.png b/source/_static/task-links.png
diff --git a/source/_static/task-screenshot.png b/source/_static/task-screenshot.png
diff --git a/source/_static/task-time-tracking.png b/source/_static/task-time-tracking.png
diff --git a/source/_static/task-timesheet.png b/source/_static/task-timesheet.png
diff --git a/source/_static/task-transitions.png b/source/_static/task-transitions.png
diff --git a/source/_static/thunderbird-new-calendar-step1.png b/source/_static/thunderbird-new-calendar-step1.png
diff --git a/source/_static/thunderbird-new-calendar-step2.png b/source/_static/thunderbird-new-calendar-step2.png
diff --git a/source/_static/time-into-each-column.png b/source/_static/time-into-each-column.png
diff --git a/source/_static/timetable.png b/source/_static/timetable.png
diff --git a/source/_static/transitions-export.png b/source/_static/transitions-export.png
diff --git a/source/_static/transitions.png b/source/_static/transitions.png
diff --git a/source/_static/user-mentions.png b/source/_static/user-mentions.png
diff --git a/source/_static/user-repartition.png b/source/_static/user-repartition.png
diff --git a/source/_static/web-notifications-icon.png b/source/_static/web-notifications-icon.png
diff --git a/source/_static/web-notifications.png b/source/_static/web-notifications.png
diff --git a/source/admin_guide/cli.rst b/source/admin_guide/cli.rst
@@ -0,0 +1,271 @@
+Command Line Interface
+======================
+
+Kanboard provides a simple command line interface that can be used from
+any Unix terminal. This tool can be used only on the local machine.
+
+This feature is useful to run commands outside of the web server
+processes.
+
+Usage
+-----
+
+-  Open a terminal and go to your Kanboard directory (example:
+   ``cd /var/www/kanboard``)
+-  Run the command ``./cli`` or ``php cli``
+
+.. code:: bash
+
+    Kanboard version master
+
+    Usage:
+      command [options] [arguments]
+
+    Options:
+      -h, --help            Display this help message
+      -q, --quiet           Do not output any message
+      -V, --version         Display this application version
+          --ansi            Force ANSI output
+          --no-ansi         Disable ANSI output
+      -n, --no-interaction  Do not ask any interactive question
+      -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
+    Available commands:
+      cronjob                            Execute daily cronjob
+      help                               Displays help for a command
+      job                                Execute individual job (read payload from stdin)
+      list                               Lists commands
+      version                            Display Kanboard version
+      worker                             Execute queue worker
+     db
+      db:migrate                         Execute SQL migrations
+      db:version                         Show database schema version
+     export
+      export:daily-project-column-stats  Daily project column stats CSV export (number of tasks per column and per day)
+      export:subtasks                    Subtasks CSV export
+      export:tasks                       Tasks CSV export
+      export:transitions                 Task transitions CSV export
+     locale
+      locale:compare                     Compare application translations with the fr_FR locale
+      locale:sync                        Synchronize all translations based on the fr_FR locale
+     notification
+      notification:overdue-tasks         Send notifications for overdue tasks
+     plugin
+      plugin:install                     Install a plugin from a remote Zip archive
+      plugin:uninstall                   Remove a plugin
+      plugin:upgrade                     Update all installed plugins
+     projects
+      projects:archive                   Disable projects not touched during one year
+      projects:archive-activities        Remove project activities after one year
+      projects:daily-stats               Calculate daily statistics for all projects
+     trigger
+      trigger:tasks                      Trigger scheduler event for all tasks
+     user
+      user:reset-2fa                     Remove two-factor authentication for a user
+      user:reset-password                Change user password
+
+Available commands
+------------------
+
+Tasks CSV export
+~~~~~~~~~~~~~~~~
+
+Usage:
+
+.. code:: bash
+
+    ./cli export:tasks <project_id> <start_date> <end_date>
+
+Example:
+
+.. code:: bash
+
+    ./cli export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
+
+CSV data are sent to ``stdout``.
+
+Subtasks CSV export
+~~~~~~~~~~~~~~~~~~~
+
+Usage:
+
+.. code:: bash
+
+    ./cli export:subtasks <project_id> <start_date> <end_date>
+
+Example:
+
+.. code:: bash
+
+    ./cli export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
+
+Task transitions CSV export
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Usage:
+
+.. code:: bash
+
+    ./cli export:transitions <project_id> <start_date> <end_date>
+
+Example:
+
+.. code:: bash
+
+    ./cli export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
+
+Export daily summaries data in CSV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The exported data will be printed on the standard output:
+
+.. code:: bash
+
+    ./cli export:daily-project-column-stats <project_id> <start_date> <end_date>
+
+Example:
+
+.. code:: bash
+
+    ./cli export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
+
+Send notifications for overdue tasks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Emails will be sent to all users with notifications enabled.
+
+.. code:: bash
+
+    ./cli notification:overdue-tasks
+
+Optional parameters:
+
+-  ``--show``: Display notifications sent
+-  ``--group``: Group all overdue tasks for one user (from all projects)
+   in one email
+-  ``--manager``: Send all overdue tasks to project manager(s) in one
+   email
+-  ``-p|--project project_id|identifier``: Send notifications only for
+   the given project
+
+You can also display the overdue tasks with the flag ``--show``:
+
+.. code:: bash
+
+    ./cli notification:overdue-tasks --show
+    +-----+---------+------------+------------+--------------+----------+
+    | Id  | Title   | Due date   | Project Id | Project name | Assignee |
+    +-----+---------+------------+------------+--------------+----------+
+    | 201 | Test    | 2014-10-26 | 1          | Project #0   | admin    |
+    | 202 | My task | 2014-10-28 | 1          | Project #0   |          |
+    +-----+---------+------------+------------+--------------+----------+
+
+Example to filter by project:
+
+.. code:: bash
+
+    ./cli notification:overdue-tasks --project 123
+
+Or if you have defined a project identifier:
+
+.. code:: bash
+
+    ./cli notification:overdue-tasks --project MY_PROJECT
+
+Run daily project stats calculation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This command calculate the statistics of each project:
+
+.. code:: bash
+
+    ./cli projects:daily-stats
+    Run calculation for Project #0
+    Run calculation for Project #1
+    Run calculation for Project #10
+
+Trigger for tasks
+~~~~~~~~~~~~~~~~~
+
+This command send a “daily cronjob event” to all open tasks of each
+project.
+
+.. code:: bash
+
+    ./cli trigger:tasks
+    Trigger task event: project_id=2, nb_tasks=1
+
+Reset user password
+~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli user:reset-password my_user
+
+You will be prompted for a password and confirmation. Characters are not
+printed to the screen.
+
+Remove two-factor authentication for a user
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli user:reset-2fa my_user
+
+Install a plugin
+~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip
+
+Note: Installed files will have the same permissions as the current user
+
+Remove a plugin
+~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli plugin:uninstall Budget
+
+Upgrade all plugins
+~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli plugin:upgrade
+    * Updating plugin: Budget Planning
+    * Plugin up to date: Github Authentication
+
+Run Background worker
+~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli worker
+
+Execute individual job (mostly for debugging)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    echo 'RAW_JOB_DATA' | ./cli job
+
+Execute database migrations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If the parameter ``DB_RUN_MIGRATIONS`` is set to ``false``, you have run
+the database migrations manually:
+
+.. code:: bash
+
+    ./cli db:migrate
+
+Check database schema version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+    ./cli db:version
+    Current version: 95
+    Last version: 96