summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/api-authentication.markdown36
-rw-r--r--doc/bruteforce-protection.markdown9
-rw-r--r--doc/calendar-configuration.markdown49
-rw-r--r--doc/config.markdown11
-rw-r--r--doc/debian-installation.markdown14
-rw-r--r--doc/email-configuration.markdown81
-rw-r--r--doc/es_ES/analytics.markdown10
-rw-r--r--doc/es_ES/debian-installation.markdown65
-rw-r--r--doc/faq.markdown6
-rw-r--r--doc/kanban-vs-todo-and-scrum.markdown46
-rw-r--r--doc/plugin-hooks.markdown2
11 files changed, 203 insertions, 126 deletions
diff --git a/doc/api-authentication.markdown b/doc/api-authentication.markdown
index c44a6ef9..3ba1e8f5 100644
--- a/doc/api-authentication.markdown
+++ b/doc/api-authentication.markdown
@@ -1,4 +1,4 @@
-API de autentificación
+API Authentication
==================
API endpoint
@@ -7,39 +7,33 @@ API endpoint
URL: `https://YOUR_SERVER/jsonrpc.php`
-Metedo por default (HTTP Basico)
+Default method (HTTP Basic)
---------------------------
-### Aplicación de credenciales
+### Application credentials
- Username: `jsonrpc`
-- Password: API token para la configuración de pagina
+- Password: API token on the settings page
-### Credencial de usuario
+### User credentials
-- Usar el usuario real y su password
+- Use the real username and password
-La API usa la [Autentificación Basica del esquema HTTP descrita en el RFC2617](http://www.ietf.org/rfc/rfc2617.txt).
+The API use the [HTTP Basic Authentication Scheme described in the RFC2617](http://www.ietf.org/rfc/rfc2617.txt).
-Modificar el header HTTP
-------------------------
+Custom HTTP header
+------------------
-Se puede usar un hedear HTTP alternativo para la autentificación si tu servidor es muy especifico
-You can use an alternative HTTP header for the authentication if your server have a very specific
-configuración.
-configuration.
+You can use an alternative HTTP header for the authentication if your server have a very specific configuration.
- The header name can be anything you want, by example `X-API-Auth`.
- The header value is the `username:password` encoded in Base64.
-Configuración:
+Configuration:
-1. Definir tu cabecera modificada en tu `config.php`: `define('API_AUTHENTICATION_HEADER', 'X-API-Auth');`
1. Define your custom header in your `config.php`: `define('API_AUTHENTICATION_HEADER', 'X-API-Auth');`
-2. Codificar las credenciales en Base64, ejemplo con PHP
2. Encode the credentials in Base64, example with PHP `base64_encode('jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929');`
-3. Verificar con curl
3. Test with curl:
```bash
@@ -49,19 +43,13 @@ curl \
http://localhost/kanboard/jsonrpc.php
```
-Error de autentificación
--------------------------
Authentication error
--------------------
-Si las credenciales son , recibiras un `401 Not Authorized` y el correspondiente respuesta del JSON.
If the credentials are wrong, you will receive a `401 Not Authorized` and the corresponding JSON response.
-
-Error de Autorización
-----------------------
+
Authorization error
-------------------
-Si el usuario no , recibira un `403 Forbidden`.
If the connected user is not allowed to access to the resource, you will receive a `403 Forbidden`.
diff --git a/doc/bruteforce-protection.markdown b/doc/bruteforce-protection.markdown
index a7bef45e..2f75b919 100644
--- a/doc/bruteforce-protection.markdown
+++ b/doc/bruteforce-protection.markdown
@@ -12,6 +12,9 @@ However, **after three authentication failure through the user API**, the accoun
Kanboard doesn't block any IP addresses since bots can use several anonymous proxies. However, you can use external tools like [fail2ban](http://www.fail2ban.org) to avoid massive scans.
+Configuration
+-------------
+
Default settings can be changed with these configuration variables:
```php
@@ -24,3 +27,9 @@ define('BRUTEFORCE_LOCKDOWN', 6);
// Lock account duration in minutes
define('BRUTEFORCE_LOCKDOWN_DURATION', 15);
```
+
+Unlocking users
+---------------
+
+If you don't want to wait 15 minutes, you can unlock a user from the user interface.
+As administrator, go to the user profile and click on "Unlock this user".
diff --git a/doc/calendar-configuration.markdown b/doc/calendar-configuration.markdown
index 6e5a099a..e46c66c3 100644
--- a/doc/calendar-configuration.markdown
+++ b/doc/calendar-configuration.markdown
@@ -1,45 +1,42 @@
-Configuración de calendarios
+Calendar settings
=================
-Ir al menu de configuraciones, despues elegir cofiguracion de calendarios que se encuentra al lado izquierdo
+Go to the menu **Settings**, then choose **Calendar settings** on the left.
-![Configuración de calendarios](https://kanboard.net/screenshots/documentation/calendar-settings.png)
+![Calendar settings](https://kanboard.net/screenshots/documentation/calendar-settings.png)
-Existe dos diferentes calendarios en kanboard :
+There are two different calendars in Kanboard:
-- Calendarios de projectos
-- Calendario por usuario (disponible desde el dashboard)
+- Project calendar
+- User calendar (available from the dashboard)
-Calendario por projectos
+Project calendar
----------------
-Este calendario visualiza las tareas que se le asignan fechas de vencimiento y las tareas estan basadas sobre
-la fecha de creación o el inicio de fecha
+This calendar shows tasks with defined due date and tasks based on the creation date or the start date.
-### Visualizar tareas basadas en la fecha de creacion
+### Show tasks based on the creation date
-- El inicio de fecha del evento del calendario es la fecha de creacion de la tarea
-- El finalización de fecha del evento es cuendo se completa una tarea
+- The start date of the calendar event is the creation date of the task.
+- The end date of the event is the date of completion.
-### Visualizar tareas basadas en las fechas de inicio
+### Show tasks based on the start date
-- La fecha de inicio del evento del calendario is la fecha de incio de la tarea
-- Esta fecha puede ser definida manualmente.
-- La fecha de finalización del evento es la fecha de terminación
-- Si no hay una fecha de inicio de la tarea no aparece en el calendario.
+- The start date of the calendar event is the start date of the task.
+- This date can be defined manually.
+- The end date of the event is the date of completion.
+- If there is no start date the task will not appear on the calendar.
-Calendarios por usuarios
+User calendar
-------------
-Este calendario visualiza solo las tareas asignadas para el usuario y opcionalmente la información de las subtareas
+This calendar shows only tasks assigned to the user and optionally sub-tasks information.
-###
-Visualizar subtareas basadas en el tiempo de tracking
+### Show sub-tasks based on the time tracking
-- Despliega la información de las subtareas desde el calendario o en el registro de la tabla de seguimiento de tiempo
-- La intersección con los usuarios timetable es calculad
+- Display sub-tasks in the calendar from the information recorded in the time tracking table.
+- The intersection with the user timetable is also calculated.
-### Las estimaciones muestran las subtareas ( la previsión de los trabajos futuros )
+### Show sub-task estimates (forecast of future work)
--
-Mostrar la estimación de los trabajos futuros de las subtareas en estado de "todo" y con un valor definido " estimación " .
+- Display the estimate of future work for sub-tasks in status "todo" and with a defined "estimate" value.
diff --git a/doc/config.markdown b/doc/config.markdown
index e51fd54a..853fa6f2 100644
--- a/doc/config.markdown
+++ b/doc/config.markdown
@@ -37,6 +37,17 @@ Folder for uploaded files
define('FILES_DIR', 'data/files');
```
+Cache parameters
+----------------
+
+```php
+// Available cache drivers are "file" and "memory"
+define('CACHE_DRIVER', 'memory');
+
+// Cache folder to use if cache driver is "file" (must be writeable by the web server user)
+define('CACHE_DIR', DATA_DIR.DIRECTORY_SEPARATOR.'cache');
+```
+
Enable/disable url rewrite
--------------------------
diff --git a/doc/debian-installation.markdown b/doc/debian-installation.markdown
index befa2649..dab4bac7 100644
--- a/doc/debian-installation.markdown
+++ b/doc/debian-installation.markdown
@@ -1,12 +1,12 @@
-Como instalar Kanboard en debian
+How to install Kanboard on Debian?
==================================
-Nota: Algunas caracteristicas de Kanboard requieren que tu corras [un job en background diariamente](cronjob.markdown).
+Note: Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
Debian 8 (Jessie)
-----------------
-Instalar Apache y PHP :
+Install Apache and PHP:
```bash
apt-get update
@@ -14,7 +14,7 @@ apt-get install -y php5 php5-sqlite php5-gd unzip
service apache2 restart
```
-Instalar Kanboard
+Install Kanboard:
```bash
cd /var/www/html
@@ -27,14 +27,14 @@ rm kanboard-latest.zip
Debian 7 (Wheezy)
-----------------
-Instalar Apache y PHP
+Install Apache and PHP:
```bash
apt-get update
apt-get install -y php5 php5-sqlite php5-gd unzip
```
-Instalar Kanboard
+Install Kanboard:
```bash
cd /var/www
@@ -47,7 +47,7 @@ rm kanboard-latest.zip
Debian 6 (Squeeze)
------------------
-Instalar Apache y PHP
+Install Apache and PHP:
```bash
apt-get update
diff --git a/doc/email-configuration.markdown b/doc/email-configuration.markdown
index 2f044700..61d5980a 100644
--- a/doc/email-configuration.markdown
+++ b/doc/email-configuration.markdown
@@ -1,38 +1,38 @@
-Configuración del Email
+Email configuration
===================
-Configuración de usuarios
+User settings
-------------
-Para recibir notificaciones por email los usuarios de Kanboard deben tener
+To receive email notifications, users of Kanboard must have:
-- Activar las notificaciones de su perfil
-- Tener una dirección valida de email en su perfil
-- Ser miembro del proyecto y que este tenga activo la opción de notificaciones
+- Activated notifications in their profile
+- Have a valid email address in their profile
+- Be a member of the project that will trigger notifications
-Nota: El usuario que genera una sesión y que realiza alguna acción no recibe ninguna notificación, sólo otros miembros del proyecto.
+Note: The logged user who performs the action doesn't receive any notifications, only other project members.
-Comunicación con correos electronicos
+Email transports
----------------
There are several email transports available:
- SMTP
- Sendmail
-- PHP mail funcion nativa
-- Otros métodos que pueden ser proporcionados por externos : Postmark, Sendgrid and Mailgun
+- PHP native mail function
+- Other methods can be provided by external plugins: Postmark, Sendgrid and Mailgun
-Configuración del servidor
+Server settings
---------------
-Por default, Kanboard usa el bundled PHP mail function para el envio de emails.
-Porque usualmente el servidor no requiere una configuración y así tu servidor puede estar listo para enviar emails.
+By default, Kanboard will use the bundled PHP mail function to send emails.
+Usually that requires no configuration if your server can already send emails.
-Sin embargo, es posible usar otros metodos, como el protocolo SMTP y Sendmail
+However, it's possible to use other methods, the SMTP protocol and Sendmail.
-### Configuración SMTP
+### SMTP configuration
-Renombrar el archivo `config.default.php` a `config.php` y modificar estos valores:
+Rename the file `config.default.php` to `config.php` and change these values:
```php
// We choose "smtp" as mail transport
@@ -47,17 +47,17 @@ define('MAIL_SMTP_USERNAME', 'username');
define('MAIL_SMTP_PASSWORD', 'super password');
```
-También es posible utilizar una conexión segura, TLS or SSL:
+It's also possible to use a secure connection, TLS or SSL:
```php
define('MAIL_SMTP_ENCRYPTION', 'ssl'); // Valid values are "null", "ssl" or "tls"
```
-### Configuración Sendmail
+### Sendmail configuration
-Por default el comando para el sendmail esta `/usr/sbin/sendmail -bs` Pero usted puede personalizarlo en su archivo de configuración.
+By default the sendmail command will be `/usr/sbin/sendmail -bs` but you can customize that in your config file.
-Ejemplo:
+Example:
```php
// We choose "sendmail" as mail transport
@@ -67,51 +67,48 @@ define('MAIL_TRANSPORT', 'sendmail');
define('MAIL_SENDMAIL_COMMAND', '/usr/sbin/sendmail -bs');
```
-### PHP funcion nativa de email
+### PHP native mail function
-Esta es la configuración por default
+This is the default configuration:
```php
define('MAIL_TRANSPORT', 'mail');
```
-### La dirección de correo electrónico del remitente
+### The sender email address
-Por default, los correos electrónicos utilizarán la dirección del remitente `notifications@kanboard.local`.
-con este correo no es posible responderle
+By default, emails will use the sender address `notifications@kanboard.local`.
+It's not possible to reply to this address.
-Tu puedes personalizar esta direccion cambiando el valor de la constante `MAIL_FROM` en tu archivo de configuración
+You can customize this address by changing the value of the constant `MAIL_FROM` in your config file.
```php
define('MAIL_FROM', 'kanboard@mydomain.tld');
```
+That can be useful if your SMTP server configuration doesn't accept the default address.
-Esto puede ser útil si su configuracion del servidor SMTP no acepta una dirección por default.
+### How to display a link to the task in notifications?
-### Cómo mostrar un enlace a la tarea en las notificaciones ?
+To do that, you have to specify the URL of your Kanboard installation in your [Application Settings](https://kanboard.net/documentation/application-configuration).
+By default, nothing is defined, so no links will be displayed.
-Para hacer eso, tu tienes que especificar la URL de tu instalación de tu kanboard [Application Settings](https://kanboard.net/documentation/application-configuration).
-
-De manera predeterminada, no se define nada, por lo que no se mostrará los enlaces.
-
-Ejemplos :
+Examples:
- http://demo.kanboard.net/
- http://myserver/kanboard/
- http://kanboard.mydomain.com/
-No se olvide de la barra final `/`.
+Don't forget the ending slash `/`.
-Es necesario definir de forma manual debido a que Kanboard no puede adivinar la dirección URL de una secuencia de comandos de línea de comandos y algunas personas tienen una configuración muy específica.
+You need to define that manually because Kanboard cannot guess the URL from a command line script and some people have a very specific configuration.
-Solución de problemas
+Troubleshooting
---------------
+If no emails are sent and you are sure that everything is configured correctly:
-Si no hay mensajes de correo electrónico se envían y que está seguro de que todo está configurado correctamente entonces:
-
-- Verificar el correo de spam
-- Habilita el modo debug y verifique el archivo `data/debug.log`, Debería ver el error exacto
-- Asegúrese de que el servidor o el proveedor de alojamiento le permite enviar mensajes de correo electrónico
-- Si usa Selinux Permitir a PHP enviar emails
+- Check your spam folder
+- Enable the debug mode and check the debug file `data/debug.log`, you should see the exact error
+- Be sure that your server or your hosting provider allows you to send emails
+- If you use SeLinux, allow PHP to send emails
diff --git a/doc/es_ES/analytics.markdown b/doc/es_ES/analytics.markdown
index 87d0f717..b2a3d7ae 100644
--- a/doc/es_ES/analytics.markdown
+++ b/doc/es_ES/analytics.markdown
@@ -1,24 +1,24 @@
Analisis
=========
-Cada proyecto tiene una sección de análisis . Dependiendo de cómo se está utilizando Kanboard , se puede ver estos informes :
+Cada proyecto tiene una sección de análisis . Dependiendo de cómo se está utilizando Kanboard, se puede ver estos informes :
Repartición de usuarios
-------------------------
+-----------------------
![User repartition](https://kanboard.net/screenshots/documentation/user-repartition.png)
Esta gráfico de sectores muestra el numero de tareas abiertas asignadas por usuario.
Distribución de tareas
-------------------------
+----------------------
![Task distribution](https://kanboard.net/screenshots/documentation/task-distribution.png)
Este gráfico de sectores da una visión general del numero de tareas abiertas por columnas.
Diagrama de flujo acumulado
-----------------------------
+---------------------------
![Cumulative flow diagram](https://kanboard.net/screenshots/documentation/cfd.png)
@@ -56,4 +56,4 @@ Este gráfico muestra el promedio de avances y ciclo de tiempos para las ultimas
Esos indicadores se calculan y registran todos los días durante todo el proyecto.
-Nota: No olvidar ejecutar todos los dias el cronjob para tener estadísticas precisas. \ No newline at end of file
+Nota: No olvidar ejecutar todos los dias el cronjob para tener estadísticas precisas.
diff --git a/doc/es_ES/debian-installation.markdown b/doc/es_ES/debian-installation.markdown
new file mode 100644
index 00000000..5636744b
--- /dev/null
+++ b/doc/es_ES/debian-installation.markdown
@@ -0,0 +1,65 @@
+Como instalar Kanboard en debian
+================================
+
+Nota: Algunas caracteristicas de Kanboard requieren que tu corras [un job en background diariamente](cronjob.markdown).
+
+Debian 8 (Jessie)
+-----------------
+
+Instalar Apache y PHP :
+
+```bash
+apt-get update
+apt-get install -y php5 php5-sqlite php5-gd unzip
+service apache2 restart
+```
+
+Instalar Kanboard
+
+```bash
+cd /var/www/html
+wget https://kanboard.net/kanboard-latest.zip
+unzip kanboard-latest.zip
+chown -R www-data:www-data kanboard/data
+rm kanboard-latest.zip
+```
+
+Debian 7 (Wheezy)
+-----------------
+
+Instalar Apache y PHP
+
+```bash
+apt-get update
+apt-get install -y php5 php5-sqlite php5-gd unzip
+```
+
+Instalar Kanboard
+
+```bash
+cd /var/www
+wget https://kanboard.net/kanboard-latest.zip
+unzip kanboard-latest.zip
+chown -R www-data:www-data kanboard/data
+rm kanboard-latest.zip
+```
+
+Debian 6 (Squeeze)
+------------------
+
+Instalar Apache y PHP
+
+```bash
+apt-get update
+apt-get install -y libapache2-mod-php5 php5-sqlite php5-gd unzip
+```
+
+Instalar Kanboard:
+
+```bash
+cd /var/www
+wget https://kanboard.net/kanboard-latest.zip
+unzip kanboard-latest.zip
+chown -R www-data:www-data kanboard/data
+rm kanboard-latest.zip
+```
diff --git a/doc/faq.markdown b/doc/faq.markdown
index 879b070f..76ee07ab 100644
--- a/doc/faq.markdown
+++ b/doc/faq.markdown
@@ -129,3 +129,9 @@ Are there some tutorials about Kanboard in other languages?
-----------------------------------------------------------
- [German article series about Kanboard](http://demaya.de/wp/2014/07/kanboard-eine-jira-alternative-im-detail-installation/)
+
+
+Tips
+----
+
+- [Easy way to remove name constraint in SQLite database](https://github.com/kanboard/kanboard/issues/1508)
diff --git a/doc/kanban-vs-todo-and-scrum.markdown b/doc/kanban-vs-todo-and-scrum.markdown
index 184a3f6b..4e083ff8 100644
--- a/doc/kanban-vs-todo-and-scrum.markdown
+++ b/doc/kanban-vs-todo-and-scrum.markdown
@@ -1,35 +1,37 @@
Kanban vs Todo lists and Scrum
+==============================
Kanban vs Todo lists
+--------------------
-Todo lists [ lista de tareas ]:
+### Todo lists:
-Fase unica (es solo una lista de tareas)
-Multitarea posible (no eficiente)
+- Single phase (just a list of items)
+- Multitasking possible (not efficient)
-Kanban:
-
-Multi fases,
-Concentración absoluta para evitar multitareas por que se puede establecer un limite por columna para mejorar el progreso
+### Kanban:
+- Multiple phases, each column represent a step
+- Bring focus and avoid multitasking because you can set a work in progress limit per column
Kanban vs Scrum
+---------------
-Scrum:
+### Scrum:
-Los sprints son time-boxed, usualmente 2 o 4 semanas
-No permitir cambios durante la iteración
-La estimación es requerida
-Utiliza la velocidad como métrica predeterminada
-El tablero de Scrum se borra entre cada sprint
-Scrum tiene funciones predefinidas como scrum master , los dueños del producto y el equipo
-Una gran cantidad de reuniones: planeaciones, backlogs grooming, daily stand-up, retrospectiva
+- Sprints are time-boxed, usually 2 or 4 weeks
+- Do not allow changes during the iteration
+- Estimation is required
+- Uses velocity as default metric
+- Scrum board is cleared between each sprint
+- Scrum has pre-defined roles like scrum master, product owners and the team
+- A lot of meetings: planning, backlogs grooming, daily stand-up, retrospective
-Kanban:
+### Kanban:
-Fluido continuo
-Los cambios se pueden crear en cualquier momento
-La estimacion es opcional
-Usa la iniciativa del tiempo de ciclo para apresurar el performance
-el tablero Kanban board es persistente
-Kanban no impone estrictas restricciones y reuniones, el proceso es mas flexible
+- Continuous flow
+- Changes can be made at anytime
+- Estimation is optional
+- Use lead and cycle time to measure performance
+- Kanban board is persistent
+- Kanban doesn't impose strict constraints or meetings, process is more flexible
diff --git a/doc/plugin-hooks.markdown b/doc/plugin-hooks.markdown
index 444b76db..b5d25a40 100644
--- a/doc/plugin-hooks.markdown
+++ b/doc/plugin-hooks.markdown
@@ -218,6 +218,8 @@ 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:project-list:menu:before` | Project list: before menu entries |
+| `template:project-list:menu:after` | Project list: after menu entries |
| `template:task:layout:top` | Task layout top (after page header) |
| `template:task:details:top` | Task summary top |
| `template:task:details:bottom` | Task summary bottom |