summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorImbasaur <yarrusg@gmail.com>2016-04-29 15:20:48 +0200
committerImbasaur <yarrusg@gmail.com>2016-04-29 15:20:48 +0200
commit7459bc1c40af72441ccdaff944ef2dc9465ba9bf (patch)
treefea088cdda93079aee9e719a1bbe8464358efbb0 /doc
parent99f275e5bb033cca33eee87b0e914645730f13d1 (diff)
parent81a25cbe6328eab7c4de0befc64186610ecc7f49 (diff)
Merge pull request #2 from fguillot/master
merge
Diffstat (limited to 'doc')
-rw-r--r--doc/api-group-member-procedures.markdown36
-rw-r--r--doc/api-task-procedures.markdown61
-rw-r--r--doc/cli.markdown6
-rw-r--r--doc/faq.markdown14
-rw-r--r--doc/index.markdown1
-rw-r--r--doc/installation.markdown19
-rw-r--r--doc/nitrous.markdown10
-rw-r--r--doc/plugin-hooks.markdown12
8 files changed, 157 insertions, 2 deletions
diff --git a/doc/api-group-member-procedures.markdown b/doc/api-group-member-procedures.markdown
index c4889265..1065ba11 100644
--- a/doc/api-group-member-procedures.markdown
+++ b/doc/api-group-member-procedures.markdown
@@ -1,6 +1,42 @@
Group Member API Procedures
===========================
+## getMemberGroups
+
+- Purpose: **Get all groups for a given user**
+- Parameters:
+ - **user_id** (integer, required)
+- Result on success: **List of groups**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "getMemberGroups",
+ "id": 1987176726,
+ "params": [
+ "1"
+ ]
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1987176726,
+ "result": [
+ {
+ "id": "1",
+ "name": "My Group A"
+ }
+ ]
+}
+```
+
## getGroupMembers
- Purpose: **Get all members of a group**
diff --git a/doc/api-task-procedures.markdown b/doc/api-task-procedures.markdown
index 486c0a09..934b1e09 100644
--- a/doc/api-task-procedures.markdown
+++ b/doc/api-task-procedures.markdown
@@ -16,6 +16,7 @@ API Task Procedures
- **category_id** (integer, optional)
- **score** (integer, optional)
- **swimlane_id** (integer, optional)
+ - **priority** (integer, optional)
- **recurrence_status** (integer, optional)
- **recurrence_trigger** (integer, optional)
- **recurrence_factor** (integer, optional)
@@ -398,6 +399,7 @@ Response example:
- **description** Markdown content (string, optional)
- **category_id** (integer, optional)
- **score** (integer, optional)
+ - **priority** (integer, optional)
- **recurrence_status** (integer, optional)
- **recurrence_trigger** (integer, optional)
- **recurrence_factor** (integer, optional)
@@ -634,3 +636,62 @@ Response example:
"result": 6
}
```
+
+## searchTasks
+
+- Purpose: **Find tasks by using the search engine**
+- Parameters:
+ - **project_id** (integer, required)
+ - **query** (string, required)
+- Result on success: **list of tasks**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "searchTasks",
+ "id": 1468511716,
+ "params": {
+ "project_id": 2,
+ "query": "assignee:nobody"
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1468511716,
+ "result": [
+ {
+ "nb_comments": "0",
+ "nb_files": "0",
+ "nb_subtasks": "0",
+ "nb_completed_subtasks": "0",
+ "nb_links": "0",
+ "nb_external_links": "0",
+ "is_milestone": null,
+ "id": "3",
+ "reference": "",
+ "title": "T3",
+ "description": "",
+ "date_creation": "1461365164",
+ "date_modification": "1461365164",
+ "date_completed": null,
+ "date_started": null,
+ "date_due": "0",
+ "color_id": "yellow",
+ "project_id": "2",
+ "column_id": "5",
+ "swimlane_id": "0",
+ "owner_id": "0",
+ "creator_id": "0"
+ // ...
+ }
+ ]
+}
+```
diff --git a/doc/cli.markdown b/doc/cli.markdown
index d38d8b53..20e3566a 100644
--- a/doc/cli.markdown
+++ b/doc/cli.markdown
@@ -119,6 +119,12 @@ Emails will be sent to all users with notifications enabled.
./kanboard 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
+
You can also display the overdue tasks with the flag `--show`:
```bash
diff --git a/doc/faq.markdown b/doc/faq.markdown
index 0a9129f2..879b070f 100644
--- a/doc/faq.markdown
+++ b/doc/faq.markdown
@@ -49,6 +49,18 @@ php_value arg_separator.output "&"
Otherwise Kanboard will try to override the value directly in PHP.
+Authentication failure with the API and Apache + PHP-FPM
+--------------------------------------------------------
+
+php-cgi under Apache does not pass HTTP Basic user/pass to PHP by default.
+For this workaround to work, add these lines to your `.htaccess` file:
+
+```
+RewriteCond %{HTTP:Authorization} ^(.+)$
+RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
+```
+
+
Known issues with eAccelerator
------------------------------
@@ -109,6 +121,8 @@ Where can I find a list of related projects?
- [Trello import script by @matueranet](https://github.com/matueranet/kanboard-import-trello)
- [Chrome extension by Timo](https://chrome.google.com/webstore/detail/kanboard-quickmenu/akjbeplnnihghabpgcfmfhfmifjljneh?utm_source=chrome-ntp-icon), [Source code](https://github.com/BlueTeck/kanboard_chrome_extension)
- [Python client script by @dzudek](https://gist.github.com/fguillot/84c70d4928eb1e0cb374)
+- [Shell script for SQLite to MySQL/MariaDB migration by @oliviermaridat](https://github.com/oliviermaridat/kanboard-sqlite2mysql)
+- [Git hooks for integration with Kanboard by Gene Pavlovsky](https://github.com/gene-pavlovsky/kanboard-git-hooks)
Are there some tutorials about Kanboard in other languages?
diff --git a/doc/index.markdown b/doc/index.markdown
index 727f116d..30083fa9 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -101,6 +101,7 @@ Technical details
- [Run Kanboard with Docker](docker.markdown)
- [Run Kanboard with Vagrant](vagrant.markdown)
- [Run Kanboard on Cloudron](cloudron.markdown)
+- [Run Kanboard on Nitrous](nitrous.markdown)
### Configuration
diff --git a/doc/installation.markdown b/doc/installation.markdown
index c796ac65..d2484f0b 100644
--- a/doc/installation.markdown
+++ b/doc/installation.markdown
@@ -34,6 +34,25 @@ You must install [composer](https://getcomposer.org/) to use this method.
Note: This method will install the **current development version**, use at your own risk.
+Installation outside of the document root
+-----------------------------------------
+
+If you would like to install Kanboard outside of the web server document root, you need to create at least these symlinks:
+
+```bash
+.
+├── assets -> ../kanboard/assets
+├── doc -> ../kanboard/doc
+├── favicon.ico -> ../kanboard/favicon.ico
+├── index.php -> ../kanboard/index.php
+├── jsonrpc.php -> ../kanboard/jsonrpc.php
+└── robots.txt -> ../kanboard/robots.txt
+```
+
+The `.htaccess` is optional because its content can be included directly in the Apache configuration.
+
+You can also define a custom location for the plugins and files folders by changing the [config file](config.markdown).
+
Security
--------
diff --git a/doc/nitrous.markdown b/doc/nitrous.markdown
new file mode 100644
index 00000000..daaedcef
--- /dev/null
+++ b/doc/nitrous.markdown
@@ -0,0 +1,10 @@
+Nitrous Quickstart
+==================
+
+Create a free development environment for this Kanboard project in the cloud on [Nitrous.io](https://www.nitrous.io) by clicking the button below.
+
+<a href="https://www.nitrous.io/quickstart">
+ <img src="https://nitrous-image-icons.s3.amazonaws.com/quickstart.png" alt="Nitrous Quickstart" width=142 height=34>
+</a>
+
+Simply access your site via the `Preview > 3000` link in the IDE.
diff --git a/doc/plugin-hooks.markdown b/doc/plugin-hooks.markdown
index a00aba16..f6760f96 100644
--- a/doc/plugin-hooks.markdown
+++ b/doc/plugin-hooks.markdown
@@ -169,8 +169,16 @@ List of template hooks:
| `template:project:integrations` | Integration page in projects settings |
| `template:project:sidebar` | Sidebar in project settings |
| `template:project-user:sidebar` | Sidebar on project user overview page |
+| `template:task:layout:top` | Task layout top (after page header) |
+| `template:task:details:top` | Task summary top |
+| `template:task:details:bottom` | Task summary bottom |
+| `template:task:details:first-column` | Task summary first column |
+| `template:task:details:second-column` | Task summary second column |
+| `template:task:details:third-column` | Task summary third column |
+| `template:task:details:fourth-column` | Task summary fourth column |
| `template:task:dropdown` | Task dropdown menu in listing pages |
-| `template:task:sidebar` | Sidebar on task page |
+| `template:task:sidebar:actions` | Sidebar on task page (section actions) |
+| `template:task:sidebar:information` | Sidebar on task page (section information) |
| `template:task:form:left-column` | Left column in task form |
| `template:task:form:right-column` | Right column in task form |
| `template:task:show:top ` | Show task page: top |
@@ -179,7 +187,7 @@ List of template hooks:
| `template:task:show:before-tasklinks` | Show task page: before tasklinks |
| `template:task:show:before-subtasks` | Show task page: before subtasks |
| `template:task:show:before-timetracking` | Show task page: before timetracking |
-| `template:task:show:before-attachements` | Show task page: before attachments |
+| `template:task:show:before-attachments` | Show task page: before attachments |
| `template:task:show:before-comments` | Show task page: before comments |
| `template:user:authentication:form` | "Edit authentication" form in user profile |
| `template:user:create-remote:form` | "Create remote user" form |