Merge manually PR #2614 (Spanish doc translation)
This commit is contained in:
Frederic Guillot
parent
966fe70858
commit
b51c693cda
|
|
@ -0,0 +1,152 @@
|
|||
Ejemplos de API
|
||||
============
|
||||
|
||||
Ejemplo con cURL
|
||||
-----------------
|
||||
|
||||
Desde la línea de comandos:
|
||||
|
||||
```bash
|
||||
curl \
|
||||
-u "jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929" \
|
||||
-d '{"jsonrpc": "2.0", "method": "getAllProjects", "id": 1}' \
|
||||
http://localhost/kanboard/jsonrpc.php
|
||||
```
|
||||
|
||||
Respuesta desde el servidor:
|
||||
|
||||
```json
|
||||
{
|
||||
"jsonrpc":"2.0",
|
||||
"id":1,
|
||||
"result":[
|
||||
{
|
||||
"id":"1",
|
||||
"name":"API test",
|
||||
"is_active":"1",
|
||||
"token":"6bd0932fe7f4b5e6e4bc3c72800bfdef36a2c5de2f38f756dfb5bd632ebf",
|
||||
"last_modified":"1403392631"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Ejemplo con Python
|
||||
-------------------
|
||||
|
||||
Puede utilizar el [cliente oficial Python para Kanboard](https://github.com/kanboard/kanboard-api-python):
|
||||
|
||||
```bash
|
||||
pip install kanboard
|
||||
```
|
||||
|
||||
Aquí un ejemplo para crear un proyecto y una tarea:
|
||||
|
||||
```python
|
||||
from kanboard import Kanboard
|
||||
|
||||
kb = Kanboard("http://localhost/jsonrpc.php", "jsonrpc", "your_api_token")
|
||||
|
||||
project_id = kb.create_project(name="My project")
|
||||
|
||||
task_id = kb.create_task(project_id=project_id, title="My task title")
|
||||
```
|
||||
|
||||
Hay mas ejemplos en el [sitio web oficial(https://github.com/kanboard/kanboard-api-python).
|
||||
|
||||
Ejemplo con un cliente PHP
|
||||
-------------------------
|
||||
|
||||
Puede utilizar esta [librearia Json-RPC de Cliente/servidor para PHP](https://github.com/fguillot/JsonRPC), Aqui un ejemplo:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$client = new JsonRPC\Client('http://localhost:8000/jsonrpc.php');
|
||||
$client->authentication('jsonrpc', '19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929');
|
||||
|
||||
print_r($client->getAllProjects());
|
||||
|
||||
```
|
||||
|
||||
La respuesta:
|
||||
|
||||
```
|
||||
Array
|
||||
(
|
||||
[0] => Array
|
||||
(
|
||||
[id] => 1
|
||||
[name] => API test
|
||||
[is_active] => 1
|
||||
[token] => 6bd0932fe7f4b5e6e4bc3c72800bfdef36a2c5de2f38f756dfb5bd632ebf
|
||||
[last_modified] => 1403392631
|
||||
)
|
||||
|
||||
)
|
||||
```
|
||||
|
||||
Ejemplo con Ruby
|
||||
-----------------
|
||||
|
||||
Este ejmeplo puede ser usado con Kanboard configurado con autenticación de Proxy Inverso y la API configurada con una cabecerza de autenticación personalizada:
|
||||
|
||||
```ruby
|
||||
require 'faraday'
|
||||
|
||||
conn = Faraday.new(:url => 'https://kanboard.example.com') do |faraday|
|
||||
faraday.response :logger
|
||||
faraday.headers['X-API-Auth'] = 'XXX' # base64_encode('jsonrpc:API_KEY')
|
||||
faraday.basic_auth(ENV['user'], ENV['pw']) # user/pass to get through basic auth
|
||||
faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
|
||||
end
|
||||
|
||||
response = conn.post do |req|
|
||||
req.url '/jsonrpc.php'
|
||||
req.headers['Content-Type'] = 'application/json'
|
||||
req.body = '{ "jsonrpc": "2.0", "id": 1, "method": "getAllProjects" }'
|
||||
end
|
||||
|
||||
puts response.body
|
||||
```
|
||||
|
||||
|
||||
Ejemplo con Java
|
||||
-----------------
|
||||
|
||||
Este es un ejemplo basico usando Spring. Para su uso correcto vea [Este enlace](http://spring.io/guides/gs/consuming-rest).
|
||||
|
||||
```java
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.util.Base64;
|
||||
|
||||
import org.springframework.http.HttpEntity;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
public class ProjectService {
|
||||
|
||||
public void getAllProjects() throws UnsupportedEncodingException {
|
||||
|
||||
RestTemplate restTemplate = new RestTemplate();
|
||||
|
||||
String url = "http://localhost/kanboard/jsonrpc.php";
|
||||
String requestJson = "{\"jsonrpc\": \"2.0\", \"method\": \"getAllProjects\", \"id\": 1}";
|
||||
String user = "jsonrpc";
|
||||
String apiToken = "19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929";
|
||||
|
||||
// encode api token
|
||||
byte[] xApiAuthTokenBytes = String.join(":", user, apiToken).getBytes("utf-8");
|
||||
String xApiAuthToken = Base64.getEncoder().encodeToString(xApiAuthTokenBytes);
|
||||
|
||||
// consume request
|
||||
HttpHeaders headers = new HttpHeaders();
|
||||
headers.add("X-API-Auth", xApiAuthToken);
|
||||
headers.setContentType(MediaType.APPLICATION_JSON);
|
||||
HttpEntity<String> entity = new HttpEntity<String>(requestJson, headers);
|
||||
String answer = restTemplate.postForObject(url, entity, String.class);
|
||||
System.out.println(answer);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
Instalación en Centos
|
||||
===================
|
||||
|
||||
Nota:Algunas funciones de Kanboard requieren que se ejecute un trabajo en segundo
|
||||
plano todos los días (cronjob.markdown).
|
||||
|
||||
Centos 7
|
||||
--------
|
||||
|
||||
Instalar PHP y Apache:
|
||||
|
||||
```bash
|
||||
yum install -y php php-mbstring php-pdo php-gd unzip wget
|
||||
```
|
||||
|
||||
Por default Centos 7 use PHP 5.4.16 and Apache 2.4.6.
|
||||
|
||||
Reiniciar Apache:
|
||||
|
||||
```bash
|
||||
systemctl restart httpd.service
|
||||
```
|
||||
|
||||
InstalarKanboard:
|
||||
|
||||
```bash
|
||||
cd /var/www/html
|
||||
wget https://kanboard.net/kanboard-latest.zip
|
||||
unzip kanboard-latest.zip
|
||||
chown -R apache:apache kanboard/data
|
||||
rm kanboard-latest.zip
|
||||
```
|
||||
|
||||
Si SELinux esta activado, Asegurese de que el usuario de Apache pueda escribir en el directorio de datos:
|
||||
|
||||
```bash
|
||||
chcon -R -t httpd_sys_content_rw_t /var/www/html/kanboard/data
|
||||
```
|
||||
|
||||
Asegurese de configurar el servidor para permitir enviar correos electrónicos y hacer conexiones externas por ejemplo con SELinux:
|
||||
|
||||
```bash
|
||||
setsebool -P httpd_can_network_connect=1
|
||||
```
|
||||
|
||||
Las conexiones son necesarias si se usa LDAP,SMTP, ganchos web o cualquier integracion de terceros:
|
||||
|
||||
Centos 6.x
|
||||
----------
|
||||
|
||||
Instalar PHP y Apache:
|
||||
|
||||
```bash
|
||||
yum install -y php php-mbstring php-pdo php-gd unzip wget
|
||||
```
|
||||
|
||||
Por defecto para Centos 6.5 use PHP 5.3.3 y Apache 2.2.15
|
||||
|
||||
Active las etiquetas cortas:
|
||||
|
||||
- Editar el archivo `/etc/php.ini`
|
||||
- Cambiar la linea `short_open_tag = On`
|
||||
|
||||
Reiniciar Apache:
|
||||
|
||||
```bash
|
||||
service httpd restart
|
||||
```
|
||||
|
||||
Instalar Kanboard:
|
||||
|
||||
```bash
|
||||
cd /var/www/html
|
||||
wget https://kanboard.net/kanboard-latest.zip
|
||||
unzip kanboard-latest.zip
|
||||
chown -R apache:apache kanboard/data
|
||||
rm kanboard-latest.zip
|
||||
```
|
||||
|
||||
Ir a `http://your_server/kanboard/`.
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
Instalación
|
||||
|
||||
En primer lugar, comprobar los [requisitos] (requirements.markdown)antes de ir más lejos.
|
||||
|
||||
Del archivo (versión estable)
|
||||
---------------------------------
|
||||
|
||||
|
||||
1. Debe tener un servidor web con PHP instalado
|
||||
2. Descargar el código fuente y copiar el directorio ` kanboard` en la que desea.
|
||||
3. Comprobar si el directorio ` data` se puede escribir
|
||||
4. Con el navegador vaya a < http://yourpersonalserver/kanboard >
|
||||
5. El nombre de usuario y contraseña por defecto es ** admin / admin **
|
||||
6. Comience a utilizar el software
|
||||
7. No se olvide de cambiar su contraseña!
|
||||
|
||||
|
||||
La carpeta de datos se utiliza para almacenar:
|
||||
|
||||
- Base de datos SQLite: ` db.sqlite`
|
||||
- Archivo de depuración: ` debug.log` (si está activado el modo de depuración)
|
||||
- Archivos cargados: ` ficheros / *`
|
||||
- miniaturas de imagen: ` ficheros / miniaturas / *`
|
||||
|
||||
Las personas que están utilizando una base de datos remota (MySQL / PostgreSQL) y un almacenamiento de archivos a distancia (AWS S3 o similar) no necesariamente tienen que tener una carpeta de datos local persistente o para cambiar el permiso.
|
||||
|
||||
Desde el repositorio (versión de desarrollo)
|
||||
-----------------------------------------
|
||||
|
||||
|
||||
Debe instalar [compositora] (https://getcomposer.org/)para utilizar este método.
|
||||
|
||||
1. ` git clone https: // github.com / kanboard / kanboard.git`
|
||||
2. ` compositor instalar --no- dev`
|
||||
3. Ir a la tercera etapa justo por encima
|
||||
|
||||
Nota: Este método se instalará la versión de desarrollo actual ** ** , utilice a su propio riesgo .
|
||||
|
||||
Instalación exterior de la raíz del documento
|
||||
---------------------------------------------
|
||||
|
||||
Si desea instalar Kanboard fuera de la raíz de documentos del servidor web, es necesario crear al menos estos enlaces simbólicos:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
El ` .htaccess` es opcional, ya que su contenido puede ser incluido directamente en la configuración de Apache.
|
||||
|
||||
También puede definir una ubicación personalizada para los plugins y carpetas de archivos cambiando el [archivo de configuración] (config.markdown).
|
||||
|
||||
La instalación opcional
|
||||
|
||||
---------------------
|
||||
|
||||
- Algunas funciones de Kanboard requieren que ejecuta [un trabajo en segundo plano todos los días] (cronjob.markdown) (Informes y análisis)
|
||||
- [Instalar el trabajador fondo] (worker.markdown) para mejorar las prestaciones
|
||||
|
||||
Seguridad
|
||||
---------
|
||||
|
||||
|
||||
- No se olvide de cambiar el usuario por defecto / contraseña
|
||||
- No permita a todo el mundo para acceder al directorio ` data` de la URL.
|
||||
Ya existe un ` .htaccess` para Apache , pero nada para los demás servidores web.
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
Subtareas
|
||||
========
|
||||
|
||||
Las subtareas son utiles por que dividen el trabajo de las tareas.
|
||||
|
||||
Cada subtareas:
|
||||
|
||||
- Se puede asignar a un miembro del proyecto
|
||||
- Tiene 3 diferentes estado: **Todo**, **En progreso**, **Realizado**
|
||||
- Tienen rastreo de información: **tiempo gastado** y **tiempo estimado**
|
||||
- Ordenar por posición
|
||||
|
||||
Crear subtareas
|
||||
-----------------
|
||||
|
||||
Desde la vista de la tarea en la barra lateral izquierda haga clic en **Agregar una subtarea**:
|
||||
|
||||
|
||||
|
||||
Tambien puede agregar una subtarea rápidamente introduciendo solamente el titulo:
|
||||
|
||||
|
||||
|
||||
Cambiar estado de subtarea
|
||||
-------------------------
|
||||
|
||||
Al hacer clic en el título de la subtarea, se hace el cambio de estado :
|
||||
|
||||
|
||||
|
||||
El icono antes de que el titulo se actualice el estatus.
|
||||
|
||||
|
||||
|
||||
Nota: cuando la tarea se cierra todas las subtareas se cambian al estado **Hecho**.
|
||||
|
||||
Temporizador de subtarea
|
||||
-------------------------
|
||||
|
||||
- Cada vez que una subtarea está en marcha, el temporizador se inicia también
|
||||
El temporizador puede ser iniciado y detenido en cualquier momento.
|
||||
- El contador registra el tiempo empleado en la subtarea automáticamente.
|
||||
También puede cambiar manualmente el valor del campo, al editar una subtarea.
|
||||
- El cálculo de tiempo se redondea al cuarto más cercano.Esta información se registra en una tabla separada.
|
||||
- El tiempo de tarea y tiempo de estimados es de actualización automáticamente según la suma de todas las subtareas.
|
||||
|
||||
Loading…
Reference in New Issue