From 017b4cc3c671368f889dbd6dded12c8482398c18 Mon Sep 17 00:00:00 2001 From: "JLGC @monolinux" Date: Tue, 23 Aug 2016 23:20:18 -0500 Subject: modificando la carpeta para el envio de documentacion manual #teamjungla{CODE} --- doc/es_ES/2fa.markdown | 33 +++++++++++++++ doc/es_ES/analytics.markdown | 59 +++++++++++++++++++++++++++ doc/es_ES/api-authentication.markdown | 60 +++++++++++++++++++++++++++ doc/es_ES/api-json-rpc.markdown | 69 ++++++++++++++++++++++++++++++++ doc/es_ES/bruteforce-protection.markdown | 26 ++++++++++++ doc/es_ES/user-mentions.markdown | 18 +++++++++ 6 files changed, 265 insertions(+) create mode 100644 doc/es_ES/2fa.markdown create mode 100644 doc/es_ES/analytics.markdown create mode 100644 doc/es_ES/api-authentication.markdown create mode 100644 doc/es_ES/api-json-rpc.markdown create mode 100644 doc/es_ES/bruteforce-protection.markdown create mode 100644 doc/es_ES/user-mentions.markdown (limited to 'doc/es_ES') diff --git a/doc/es_ES/2fa.markdown b/doc/es_ES/2fa.markdown new file mode 100644 index 00000000..18e13b88 --- /dev/null +++ b/doc/es_ES/2fa.markdown @@ -0,0 +1,33 @@ +Autentificación Two-Factor +=========================== + +Cada usuario puede habilitar el [two-factor authentication](http://en.wikipedia.org/wiki/Two_factor_authentication). +Antes de un logeo exitoso, un codigo one-time de (6 caracteres) se le pide a el usuaio para permitir el acceso a kanboard. + +Este codigo tiene que ser proporcionado por un software compatible generalmente instalado en tu smartphone + +Kanboard usa el [Time-based One-time Password Algorithm](http://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm) definido en el [RFC 6238](http://tools.ietf.org/html/rfc6238). + +Existen muchos softwares compatibles con el standard del sistema TOTP. +Por ejemplo, tu puedes usar estas aplicaciones libres y de open source: + +- [Google Authenticator](https://github.com/google/google-authenticator/) (Android, iOS, Blackberry) +- [FreeOTP](https://fedorahosted.org/freeotp/) (Android, iOS) +- [OATH Toolkit](http://www.nongnu.org/oath-toolkit/) (Utilidad en linea de comandos Unix/Linux + +Este sistema puede trabajar offline y no es necesario tener un telefono movil + +Instalacion +------------ + +1. Ir a tu perfil de usuario +2. Click a la izquierda en **Two factor authentication** y selecionar la caja +3. Una key secret es geradada para ti + +![2FA](https://kanboard.net/screenshots/documentation/2fa.png) + +- Tienes que salvar la key secret en tu software TOTP. Si usas un smartphone, la solución sera mas fácil ya que puedes escanear el Qr code con FreeOTP o Google Authenticator. +- Cada vez que abras una nueva session , un nuevo código se pedirá. +- No se olvide de verficar el dispositivo antes de cerrar la sesión + +Una nueva key secret es generada cada vez que actives o desactives esta función \ No newline at end of file diff --git a/doc/es_ES/analytics.markdown b/doc/es_ES/analytics.markdown new file mode 100644 index 00000000..87d0f717 --- /dev/null +++ b/doc/es_ES/analytics.markdown @@ -0,0 +1,59 @@ +Analisis +========= + +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) + +- Este gráfico muesta el numerto de tareas acumuladas por cada columna a través del tiempo. +- Cada día , el número total de tareas se registra para cada columna. +- Si tu quiseras excluir las tareas cerradas, deberá cambiar las configuraciones globales del proyecto + +Nota: Necesitas tener al menos dos dias de datos para mirar la gráfica + + +Gráfico Burn down + +El gráfico burn down esta dispobible para cada proyecto. + + Esta gráfico es un represtación grafica del trabajo This chart is a graphical representation del trabajo laborado contra el tiempo. + Kanboard usa la complejidad o historia de puntos para generar este diagrama. + Todos los días, se calcula la suma de los puntos de la historia de cada columna . + +Average time spent into each column + This chart shows the average time spent into each column for the last 1000 tasks. + + Kanboard uses the task transitions to calculate the data. + The time spent is calculated until the task is closed. + + +Promedio de avances y ciclos de tiempos + + +Este gráfico muestra el promedio de avances y ciclo de tiempos para las ultimas 1000 tareas fuera de tiempo. + + El tiempo promedio es el tiempo entre la creación de la tarea y la fecha de finalización + El tiempo de ciclo se encuentra entre la fecha de inicio de la tarea especificada y fecha de la tarea finalizada + Si la tarea no es cerrada, + If the task is not closed, el momento actual se utiliza en lugar de la fecha de finalización. + +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 diff --git a/doc/es_ES/api-authentication.markdown b/doc/es_ES/api-authentication.markdown new file mode 100644 index 00000000..0612ffee --- /dev/null +++ b/doc/es_ES/api-authentication.markdown @@ -0,0 +1,60 @@ +API de autentificación +================== + +API endpoint +------------ + +URL: `https://YOUR_SERVER/jsonrpc.php` + + +Metedo por default (HTTP Basico) +--------------------------- + +### Aplicación de credenciales + +- Username: `jsonrpc` +- Password: API token para la configuración de pagina + +### Credencial de usuario + +- Usar el usuario real y su password + +La API usa la [Autentificación Basica del esquema HTTP descrita en el RFC2617](http://www.ietf.org/rfc/rfc2617.txt). + + +Modificar el header HTTP +------------------------ + +Se puede usar un header HTTP alternativo para la autentificación si tu servidor es muy especifico + +configuration. + +- El nombre del header puede ser cualquier cosa que desee, por ejemplo `X-API-Auth`. +- El valor del header `username:password` esta codificado en Base64. + +Configuración: + +1. Definir tu header personalizado en tu `config.php`: `define('API_AUTHENTICATION_HEADER', 'X-API-Auth');` +2. Codificar las credenciales en Base64, ejemplo con PHP `base64_encode('jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929');` +3. Verificar con curl + +```bash +curl \ +-H 'X-API-Auth: anNvbnJwYzoxOWZmZDk3MDlkMDNjZTUwNjc1YzNhNDNkMWM0OWMxYWMyMDdmNGJjNDVmMDZjNWIyNzAxZmJkZjg5Mjk=' \ +-d '{"jsonrpc": "2.0", "method": "getAllProjects", "id": 1}' \ +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 +---------------------- + +Si el usuario conectado no tiene permiso para acceder al recurso , recibirá un `403 Forbidden`. diff --git a/doc/es_ES/api-json-rpc.markdown b/doc/es_ES/api-json-rpc.markdown new file mode 100644 index 00000000..23088890 --- /dev/null +++ b/doc/es_ES/api-json-rpc.markdown @@ -0,0 +1,69 @@ +Json-RPC API +============ + +Usuario y aplicacion API +------------------------ + +Existen dos tipos de acceso a la API: + +### API de Aplicacion + +- Acceso a la API con el usuario "jsonrpc" y el token disponible en ajustes +- Acceso a todos los procedimientos +- Sin comprobacion de permisos +- No existe sesion de usuario en el servidor +- Ejemplo de posibles clientes: Herramientas para migrar/importar datos, crear tareas desde otros sistemas, etc. + +### API de Usuario + +- Acceso a la API con las credenciales de usuario (Nombre de usuario y contraseña) +- Acceso a un conjunto restringido de procedimientos +- Los permisos del proyecto son comprobados +- Una sesion de usuario es creada en el servidor +- Ejemplo de posibles clientes: Aplicacion de escritotrio / dispositivos moviles, utilidad linea de commandos, etc. + +Seguridad +--------- + +- Siempre usa HTTPS con un certificado valido. +- Si haces una aplicacion movil, es tu trabajo almacenar de forma segura las credenciales de usuario en el dispositivo +- Despues de tres fallas de autenticación en la API de usuario, el usuario final tiene que desbloquear su cuenta utilizando el formulario de inicio de sesión +- La autenticación de dos factores aun no está disponible a través de la API + +Protocolo +--------- + +Kanboard utilizar el protocolo JSON-RPC para interactuar con programas externos. +JSON-RPC es un protocolo de llamada a procedimiento remoto codificado en JSON. Casi lo mismo que XML-RPC, pero con el formato JSON. + +Utilizamos [version 2 of the protocol](http://www.jsonrpc.org/specification). Usted debe llamar a la API con una petición HTTP POST. + +Kanboard soporta requerimientos por lotes, por lo que pueden hacer varias llamadas a la API en una sola petición HTTP. Es particularmente útil para los clientes móviles con una mayor latencia de la red. + +Uso +--- + +- [Authentication](api-authentication.markdown) +- [Examples](api-examples.markdown) +- [Application](api-application-procedures.markdown) +- [Projects](api-project-procedures.markdown) +- [Project Permissions](api-project-permission-procedures.markdown) +- [Boards](api-board-procedures.markdown) +- [Columns](api-column-procedures.markdown) +- [Swimlanes](api-swimlane-procedures.markdown) +- [Categories](api-category-procedures.markdown) +- [Automatic Actions](api-action-procedures.markdown) +- [Tasks](api-task-procedures.markdown) +- [Subtasks](api-subtask-procedures.markdown) +- [Subtask Time Tracking](api-subtask-time-tracking-procedures.markdown) +- [Task Files](api-task-file-procedures.markdown) +- [Project Files](api-project-file-procedures.markdown) +- [Links](api-link-procedures.markdown) +- [Internal Task Links](api-internal-task-link-procedures.markdown) +- [External Task Links](api-external-task-link-procedures.markdown) +- [Comments](api-comment-procedures.markdown) +- [Users](api-user-procedures.markdown) +- [Groups](api-group-procedures.markdown) +- [Group Members](api-group-member-procedures.markdown) +- [Me](api-me-procedures.markdown) + diff --git a/doc/es_ES/bruteforce-protection.markdown b/doc/es_ES/bruteforce-protection.markdown new file mode 100644 index 00000000..2a08fc27 --- /dev/null +++ b/doc/es_ES/bruteforce-protection.markdown @@ -0,0 +1,26 @@ +Protección por fuerza bruta +=========================== + +La protección por fuerza bruta de kanboard funciona en nivel a la cuenta de usuario. + +- Después de 3 fallas de autentificación para el formulario de login muestra una imagen de captcha para evitar bots automatizado orientativos. +- Después de 6 fallas de autentificación la cuenta de usuario esta bloqueada por un periodo de 15 minutos. + +Esta característica funciona para el método de autentificación del usuario API, la cuenta tiene que ser desbloqueado mediante el formulario de inicio de sesión. + +Sin embargo, después de la tercera falla de autenticidad a través de la API de usuario, la cuenta tiene que ser desbloqueado mediante el formulario de inicio de sesión. + +Kanboard no bloquea cualquier dirección de la IP ya que los bots puede utilizar a varios servidores proxy anónimo sin embargo puede utilizar herramientas externas como f[fail2ban](http://www.fail2ban.org) para evitar la exploración masiva. + +Los ajustes predeterminados se pueden cambiar con estas variables de configuración: + +```php +// Habilitar captcha después del fallo 3 de autentificación +define('BRUTEFORCE_CAPTCHA', 3); + +// Bloquear la cuenta después de 6 fallo de autentificación +define('BRUTEFORCE_LOCKDOWN', 6); + +//Bloqueo de la duración de la cuenta en minutos. +define('BRUTEFORCE_LOCKDOWN_DURATION', 15) +``` diff --git a/doc/es_ES/user-mentions.markdown b/doc/es_ES/user-mentions.markdown new file mode 100644 index 00000000..1d7410e3 --- /dev/null +++ b/doc/es_ES/user-mentions.markdown @@ -0,0 +1,18 @@ +Menciones de usuarios +===================== + +Kanboard ofrece la posibilidad de enviar notificaciones cuando alguien es mencionado. + +Si usted necesita obtener la atención de alguien en un comentario o una tarea, use el simbolo @ seguido por el usuario. +Kanboard automaticamente desplegara una lista de usuarios: + +![User Mention](screenshots/mention-autocomplete.png) + +- Por el momento, solo las descripciones de la tarea y la area de comentarios la función esta activada. +- El usuario mencionado sólo funciona durante las tareas y comentarios creados +- Para notificar, necesita mencionar a los usuarios con su membresia de proyecto +- Cuando alguien se mencionó, este usuario recibirá una notificación. +- El @username mencionado está relacionado con el perfil de usuario. + +La notificacion es enviada de acuerdo a la configuracion del usuario, se le puede enviar un email, una notificaicon via web o mensajes en Slack/Hipchat/Jabber si y cuando se tenga instalados dichos plugins. + -- cgit v1.2.3 From c4294c9cadaccb4f7f7652cbc41681ec3a2e739a Mon Sep 17 00:00:00 2001 From: "JLGC @monolinux" Date: Wed, 24 Aug 2016 21:16:21 -0500 Subject: archivo final de la semana dos @monolinux --- doc/es_ES/api-comment-procedures.markdown | 181 ++++++++++++++++++++++++++++++ 1 file changed, 181 insertions(+) create mode 100644 doc/es_ES/api-comment-procedures.markdown (limited to 'doc/es_ES') diff --git a/doc/es_ES/api-comment-procedures.markdown b/doc/es_ES/api-comment-procedures.markdown new file mode 100644 index 00000000..81389892 --- /dev/null +++ b/doc/es_ES/api-comment-procedures.markdown @@ -0,0 +1,181 @@ +API Procedimientos de comentarios +====================== + +## createComment [Crear un comentario] + +- Propósito: **Crear un nuevo comentario** +- Parametros: + - **task_id** (integer, required) + - **user_id** (integer, required) + - **content** Reducción de contenido (string, required) +- Resultado satisfactorio: **comment_id** +- Resultado fallido : **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "createComment", + "id": 1580417921, + "params": { + "task_id": 1, + "user_id": 1, + "content": "Comment #1" + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 1580417921, + "result": 11 +} +``` + +## getComment [Obtener un comentario] + +- Propósito: **Obtener la información del comentario** +- Parametros: + - **comment_id** (integer, required) +- Resultado satisfactorio: **propiedades del comentario** +- Resultado fallido: **null** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "getComment", + "id": 867839500, + "params": { + "comment_id": 1 + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 867839500, + "result": { + "id": "1", + "task_id": "1", + "user_id": "1", + "date_creation": "1410881970", + "comment": "Comment #1", + "username": "admin", + "name": null + } +} +``` + +## getAllComments [Obtener todos los comentarios] + +- Proposito: **Obtener todos los comentarios disponibles** +- Parametros: + - **task_id** (integer, required) +- Resultado satisfactorio: **Lista de comentarios** +- Resultado fallido : **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "getAllComments", + "id": 148484683, + "params": { + "task_id": 1 + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 148484683, + "result": [ + { + "id": "1", + "date_creation": "1410882272", + "task_id": "1", + "user_id": "1", + "comment": "Comment #1", + "username": "admin", + "name": null + }, + ... + ] +} +``` + +## updateComment [Actualizar un comentario] + +- Proposito: **Actualizar un comentario** +- Parametros: + - **id** (integer, required) + - **content** Reducción de contenido (string, required) +- Resultado satisfactorio: **true** +- Resultado fallido: **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "updateComment", + "id": 496470023, + "params": { + "id": 1, + "content": "Comment #1 updated" + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 1493368950, + "result": true +} +``` + +## removeComment [Eliminar un comentario] + +- Proposito : **Eliminar un comentario** +- Parametros: + - **comment_id** (integer, required) +- Resultado satisfactorio: **true** +- Resultado fallido: **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "removeComment", + "id": 328836871, + "params": { + "comment_id": 1 + } +} +``` +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 328836871, + "result": true +} +``` -- cgit v1.2.3