Skip to content

Commit

Permalink
docs: default to spanish (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
EzeKoren authored and facugon committed Mar 15, 2022
1 parent f6572ed commit 68979ae
Show file tree
Hide file tree
Showing 153 changed files with 1,755 additions and 1,753 deletions.
72 changes: 44 additions & 28 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# TheEye Supervisor Core API

## What is TheEye?
## ¿Qué es TheEye?

<table>
<tr>
<td> <img src="images/TheEye-Of-Sauron.png"></td>
<td> TheEye is a process automation platform developed in NodeJS. Best used as BPM, Rapid Backoffice Development (RDA) and processes' hub.
Technically TheEye is a choreographer
<td>
TheEye es una plataforma de automatización de procesos desarrollada en NodeJS. Puede usarla como BPM, Rapid Backoffice Development (RDA) y nucleo de procesos.
Técnicamente, TheEye es un orquestrador.
</td>
</tr>
</table>
Expand All @@ -25,47 +26,62 @@ Technically TheEye is a choreographer
</div>
</div>

## Architecture
## Arquitectura

![Image of TheEye-overview](images/TheEye-core-Architect.png)

If you want more information please read the https://documentation.theeye.io
Para más información por favor revise la documentación en https://documentation.theeye.io/

## Environment settings
## Opciones de entorno

Provide this env variables to change the initial behaviour of the core Api. Once started cannot be changed.
Modifique estas variables de entorno para cambiar el comportamiento inicial de la API. No se pueden cambiar luego de la inicialización.

* Rest API - API para interactuar con los recursos de TheEye. https://documentation.theeye.io/api/auth/

* Rest API - Api to interactar with TheEye resources. https://documentation.theeye.io/api/auth/
* Sistema de Monitoreo - Funciona como un proceso en segundo plano. Chequea el estado de los Monitores.

* Monitoring System - It works as a background process. Will check Monitors status.
* API comandante interna (Solo escucha en el puerto 6666 en localhost) - Esta API no está documentada. Se usa solamente con propósitos de administración interna.

* Internal commander API (listen on port 6666 only localhost) - This API is not documented. It is used only for internal management purpose.
### Configuración de entorno

### Environment configuration
#### Configuración básica

Basic configuration
| Nombre de la Variable | Uso |
| ---------------------------- | --- |
| PORT | Cambia el puerto de la Rest API. Por defecto 60080 |
| NODE_ENV | El archivo del que la API debe sacar la configuración. |
| DEBUG | Activa/desactiva el módulo debug. [Más información](https://www.npmjs.com/package/debug) |
| THEEYE_NODE_HOSTNAME | Extiende el módulo debug. Agrega el hostname para depurar el output y define el Hostname en contenedores Docker |
| VERSION | Versión de la API. Si no se provee se intentará usar la versión definida en git. |
| CONFIG_NOTIFICATIONS_API_URL | URL de destino para el sistema de notificaciones |

| Variable Name | Usage |
| ----- | ----- |
| PORT | change rest api port. default 60080 |
| NODE_ENV | choose the configuration file that the api should use. |
| DEBUG | enabled/disable the debug module. check npm debug module for more information |
| THEEYE_NODE_HOSTNAME | this features extends the debug module. add the hostname to debug output and used to define a Hostname on Dockers |
| VERSION | api version. if not provided will try to detected the version using git. |
| CONFIG_NOTIFICATIONS_API_URL | target notification system url |

#### Control de componentes

Components Control. Can be configured to do one o more things (or nothing)
Puede configurarse para una o más cosas (o ninguna)


| Variable Name | Usage |
| ----- | ----- |
| COMMANDER_DISABLED | disable internal commander api |
| MONITORING_DISABLED | disable monitoring system. system monitors will not be checked anymore. will only change when bots and agents send updates |
| API_DISABLED | disable rest api |
| SCHEDULER_JOBS_DISABLED | disable internal scheduler execution. scheduler-jobs will be created using the rest api but task will never be executed. theeye-jobs execution timeout will be never checked. |
| Nombre de la Variable | Uso |
| ----------------------- | --- |
| COMMANDER_DISABLED | Desactiva la API comandante interna |
| MONITORING_DISABLED | Desactiva el monitoreo del sistema. Los monitores del sistema no van a revisarse más, solo van a actualizarse cuando los bots y agentes envíen updates |
| API_DISABLED | Desactiva la Rest API |
| SCHEDULER_JOBS_DISABLED | Desactiva la ejecución del scheduler interno. Los jobs programados se seguiran creando usando la Rest API pero la tarea nunca se ejecutará. El timeout de la ejecución nunca se revisará. |

### Start development sample
### Ejemplo para iniciar el desarrollo

`DEBUG=*eye* NODE_ENV=localdev MONITORING_DISABLED= SCHEDULER_JOBS_DISABLED= npx nodemon --inspect $PWD/core/main.js`

## Changelog

TheEye se actualiza frecuentemente. En caso de hostear su propio entorno, es recomendable revisar periódicamente si hay actualizaciones disponibles para mantener su instalación al día con los últimos parches y features.

El changelog de TheEye se encuentra [aquí](https://github.com/theeye-io-team/theeye-changelog).

Nuestro entorno SaaS [app.theeye.io](http://app.theeye.io) está siempre al día con la última versión estable.

Para conocer la versión de cada componentes puede consultar el dashboard web dentro de la pestaña *Help*, o hacer un GET request a las APIS. Es habitual que todos los componentes sean actualizados en cada release, por lo que es necesario verificar las versiones de todos los componentes y actualizarlos en el mismo momento ya que suelen tener dependencias entre si.

El supervisor [`supervisor.theeye.io/api/status`](https://supervisor.theeye.io/api/status).

El Gateway [`app.theeye.io/api/status`](https://app.theeye.io/api/status).
4 changes: 2 additions & 2 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Translations
- [:us: English](/)
- [:argentina: Español](es/)
- [:us: English](en/)
- [:argentina: Español](/)
16 changes: 8 additions & 8 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
- [API for developers](/)
- [Enable access to APIs](/auth.md)
- [Indicators](/indicators/)
- Tasks
- [Basics](/tasks/)
- [Arguments](/tasks/arguments.md)
- [Monitors](/monitors/)
- [API para desarrolladores](/)
- [Habilitar acceso a las APIs](/auth.md)
- [Indicadores](/indicators/)
- Tareas
- [Introducción](/tasks/)
- [Argumentos](/tasks/arguments.md)
- [Monitores](/monitors/)
- [Jobs](/jobs/)
- [Webhooks](/webhooks/)
- [Sync](/sync/)
- [Sync](/sync/)
51 changes: 34 additions & 17 deletions docs/auth.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,53 @@
[![theeye.io](images/logo-theeye-theOeye-logo2.png)](https://theeye.io/en/index.html)

# Integration through API
# Integraión mediante la API

## Acceder a la API

Se puede acceder a la API de distintas maneras:

- [Integraión mediante la API](#integraión-mediante-la-api)
- [Acceder a la API](#acceder-a-la-api)
- [Authenticación básica](#authenticación-básica)
- [Autenticación al portador (Bearer Authentication)](#autenticación-al-portador-bearer-authentication)
- [Recursos con clave secreta propia](#recursos-con-clave-secreta-propia)
- [Tokens de integración (Integration Tokens)](#tokens-de-integración-integration-tokens)

-----

## Accessing the API
### Authenticación básica

Se puede hacer un request al endpoint de inicio de sesión de la API usando el protocolo de autenticación básica HTTP. Como la API de TheEye se comunica con el cliente por HTTPS, se recomienda enviar un POST request de autenticación a la siguiente dirección, reemplazando `${usuario}` y `${contraseña}` acorde:

* Integration Tokens
```javascript
`https://${usuario}:${contraseña}@app.theeye.io/api/auth/login`
```

* Basic Authentication & Bearer Authentication
Este request devuelve un `access_token`, el cual es una string codificada de [JWT](https://jwt.io), la cual contiene el ID del ususario, la fecha de creación y de caducidad del Token. Este token se requiere para la mayoría de las operaciones de la API, y se tiene que enviar con los requests como se explica en la siguiente sección

* Secret Token
### Autenticación al portador (Bearer Authentication)

-----
Una vez que haya recibido su `access_token`, será necesario incluirlo en sus requests como el Bearer Token para indicarle a la API el usuario del que proviene.

### Integration Tokens
Los tokens de acceso obtenidos mediante autenticación básica son válidos durante 3 horas

An Access Token is a credential that can be used by an application to access an API. Access Tokens can be either an opaque string or a JSON web token. They inform the API that the bearer of the token has been authorized to access the API and perform specific actions specified by the scope that has been granted.
### Recursos con clave secreta propia

To verify that access to the APIs has been enabled:
- Log in to TheEye Administration Console.
- You must use an administrator account.
- On the main page of the administration console, go to setting then to credentials. You can see the list of "Integration Tokens".
Algunos recursos de la API de TheEye tienen una clave secreta propia, independiente de la autenticación de usuario. Por ejemplo, se pueden ejecutar tareas sabiendo su ID y su clave secreta. [Más información](/tasks/#usando-la-secret-key-de-la-tarea-recomendado)

![dashboard_settings_credentials](images/dashboard_setting_credentials.png)
### Tokens de integración (Integration Tokens)

Los tokens de integración permiten acceder a la API. Son secuencias de caracteres auto-generadas utilizando la librería JWT (JSON Web Token).

-----
Los tokens de integración son tokens de acceso (access token) que, a diferencia de los tokens de acceso de sesión generados mediante autenticación básica, no tienen tiempo de expiración y pueden ser utilizados indefinidamente o hasta que un administrador lo elimine del sistema.
Es conveniente tener bien identificado donde serán utilizados y renovarlos periódicamente.

### Basic Authentication & Bearer Authentication

-----
Para revisar si se encuentra tokens de integración activos:

- Inicie sesión en la consola de administración de TheEye **con una cuenta de ADMINISTRADOR**

- En la página principal, diríjase a *Settings* y seleccione *credentials*. Allí se puede acceder a *Integration Tokens* donde se podrá ver los tokens de integración creados

![dashboard_settings_credentials](images/dashboard_setting_credentials.png)

### Access resources with Secret Token
71 changes: 71 additions & 0 deletions docs/en/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# TheEye Supervisor Core API

## What is TheEye?

<table>
<tr>
<td> <img src="images/TheEye-Of-Sauron.png"></td>
<td> TheEye is a process automation platform developed in NodeJS. Best used as BPM, Rapid Backoffice Development (RDA) and processes' hub.
Technically TheEye is a choreographer
</td>
</tr>
</table>
<div class="container-fluid" style="text-align: center; font-family: 'Open Sans', sans-serif; width: 100%; padding-right: 15px; padding-left: 15px; margin-right: auto; margin-left: auto;">
<div class="row" style="display: flex; flex-wrap: wrap; margin-right: -15px; margin-left: -15px;">
<div class="col-md-12" style="flex: 0 0 50%; max-width: 50%;">
<table>
<th><a href="https://bit.ly/3kyybPA"; target="_blank"><img src="https://news.theeye.io/wp-content/uploads/2021/11/TheEye_redes-sociales-linkedin.png" style="width: 45%; margin: 0 auto;"></a></th>
<th><a href="https://bit.ly/3Di5FsU"; target="_blank"><img src="https://news.theeye.io/wp-content/uploads/2021/11/TheEye_redes-sociales-grupo-rpa-copy.png" style="width: 45%; margin: 0 auto;"></a></th>
<th><a href="https://bit.ly/3kuVqtE"; target="_blank"><img src="https://news.theeye.io/wp-content/uploads/2021/11/TheEye_redes-sociales-twitter.png" style="width: 45%; margin: 0 auto;"></a></th>
<th><a href="https://bit.ly/31PIRTb"; target="_blank"><img src="https://news.theeye.io/wp-content/uploads/2021/11/TheEye_blog-theeye-news.png" style="width: 45%; margin: 0 auto;"></a></th>
<th><a href="https://bit.ly/31Q7WNT"; target="_blank"><img src="https://news.theeye.io/wp-content/uploads/2021/11/TheEye_redes-sociales-instagram.png" style="width: 45%; margin: 0 auto;"></a></th>
<th><a href="https://bit.ly/2YDFs8O"; target="_blank"><img src="https://news.theeye.io/wp-content/uploads/2021/11/TheEye_redes-sociales-youtube.png" style="width: 45%; margin: 0 auto;"></a></th>
</table>
</div>
</div>
</div>

## Architecture

![Image of TheEye-overview](images/TheEye-core-Architect.png)

If you want more information please read the https://documentation.theeye.io

## Environment settings

Provide this env variables to change the initial behaviour of the core Api. Once started cannot be changed.


* Rest API - Api to interactar with TheEye resources. https://documentation.theeye.io/api/auth/

* Monitoring System - It works as a background process. Will check Monitors status.

* Internal commander API (listen on port 6666 only localhost) - This API is not documented. It is used only for internal management purpose.

### Environment configuration

Basic configuration

| Variable Name | Usage |
| ----- | ----- |
| PORT | change rest api port. default 60080 |
| NODE_ENV | choose the configuration file that the api should use. |
| DEBUG | enabled/disable the debug module. check npm debug module for more information |
| THEEYE_NODE_HOSTNAME | this features extends the debug module. add the hostname to debug output and used to define a Hostname on Dockers |
| VERSION | api version. if not provided will try to detected the version using git. |
| CONFIG_NOTIFICATIONS_API_URL | target notification system url |


Components Control. Can be configured to do one o more things (or nothing)


| Variable Name | Usage |
| ----- | ----- |
| COMMANDER_DISABLED | disable internal commander api |
| MONITORING_DISABLED | disable monitoring system. system monitors will not be checked anymore. will only change when bots and agents send updates |
| API_DISABLED | disable rest api |
| SCHEDULER_JOBS_DISABLED | disable internal scheduler execution. scheduler-jobs will be created using the rest api but task will never be executed. theeye-jobs execution timeout will be never checked. |

### Start development sample

`DEBUG=*eye* NODE_ENV=localdev MONITORING_DISABLED= SCHEDULER_JOBS_DISABLED= npx nodemon --inspect $PWD/core/main.js`
10 changes: 10 additions & 0 deletions docs/en/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- [API for developers](en)
- [Enable access to APIs](enauth.md)
- [Indicators](enindicators/)
- Tasks
- [Basics](entasks/)
- [Arguments](entasks/arguments.md)
- [Monitors](enmonitors/)
- [Jobs](enjobs/)
- [Webhooks](enwebhooks/)
- [Sync](ensync/)
36 changes: 36 additions & 0 deletions docs/en/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[![theeye.io](images/logo-theeye-theOeye-logo2.png)](https://theeye.io/en/index.html)

# Integration through API

-----

## Accessing the API


* Integration Tokens

* Basic Authentication & Bearer Authentication

* Secret Token

-----

### Integration Tokens

An Access Token is a credential that can be used by an application to access an API. Access Tokens can be either an opaque string or a JSON web token. They inform the API that the bearer of the token has been authorized to access the API and perform specific actions specified by the scope that has been granted.

To verify that access to the APIs has been enabled:
- Log in to TheEye Administration Console.
- You must use an administrator account.
- On the main page of the administration console, go to setting then to credentials. You can see the list of "Integration Tokens".

![dashboard_settings_credentials](images/dashboard_setting_credentials.png)


-----

### Basic Authentication & Bearer Authentication

-----

### Access resources with Secret Token
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/indicators/README.md → docs/en/indicators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,4 +258,4 @@ curl -X DELETE "https://supervisor.theeye.io/indicator/title/${TITLE_INDICATOR}?

Please, check out the indicators recipe example. After importing It, fulfill the api-key and then run it, It covers the most common requirements.

Check the [Recipes Documentation](/assets/recipes/) for more details.
Check the [Recipes Documentation](enassets/recipes/) for more details.
File renamed without changes.
Loading

0 comments on commit 68979ae

Please sign in to comment.