Documentation

Last updated 14 days ago

theeye.io

Content

What is TheEye

  • A remote server managament and a monitoring tool (Devops)

  • A server provisioning tool

  • A task manager (with scheduler)

  • A Workflow creation tool (IFTTT)

  • A technical repository

  • An integration and automation platform

  • A Real time support tool

If you want start from the scratch, there's a native integration with ELK and Docker. Check this out TheEye MindMap

First Steps

To start using TheEye you will need to:

  1. Have a user account. If you don't have one go to **https://theeye.io/register and create one.

  2. Start the self-provided Bot or Install one on each server you would like to perform actions or automate from.

  3. Create your first resource from TheEye Web.

Once you've activated your user account, you'll see this Dashboard after login:

first time login

The Tutorial will guide you through the installation process of a Bot and will show you how to create a task.

In case you don't want to follow the tutorial, you can install the Bots on your own following instructions from Settings->Installer in the side menu.

settings

Quick start

Launch the self provided Bot, and begin automating processes.

Settings Menu (Installer)

Bot Installation

If it is the first time you access TheEye Website, click the link in the monitors panel where says "Click HERE to get the step by step instructions to install the Bot on Linux and Windows operating systems", otherwise go to Settings in the left menu and get to the Installation section. Installation instructions are provided for Linux and Windows systems.

  • Linux:

linux install
  • Windows:

windows install
  • Docker

docker install

After each agent installation a new monitor is shown up in the Dashboard.

For detailed installation information check the Bot:install document

Check your first resource

Check the Dashboard view after login, you should see "All up and running" in the monitors panel.

Users

TheEye provides six different user roles. You can create users on the go with the appropiate role. See the Users Management Documentation for more details.

Resources

TheEye provides a way to store technical knowledge in Resources that become usable in many different aspects. Each resource is explained hereunder.

Monitors

A monitor is used to check services' or resources' status. You can use this status information to take actions (e.g. run a task, send notification). You can always customize the time between checks.

There are five kind of monitors you can set up from TheEye: Stats, Script, API/Web Check, Process and File. Check the Monitors Documentation for more details.

  • Monitors will notify for events as desired. Check the Users ACLs' section for Notifications

Tasks

A task is an action that can be performed or executed on demand. You can also use the task scheduler to create and manage tasks that TheEye will carry out automatically at the times you specify. Check the Tasks Documentation for more details.

Scripts

You can write scripts directly from TheEye web to your servers or you can create scripts to be used as API Calls or monitors. Check the Scripts Documentation for more details.

Templates (Provisioning)

One of the main advantages brought by TheEye is the fact that all your technical stuff is stashed at the moment it is created (scripts, tasks, monitors). Provisioning allows you to reuse your stuff for other servers in the same way a template works. To reuse all the resources created for a server, go to Templates in the left menu, select your source host in the base template input box, set a name for the template and select your destination hosts in the Hosts to add to the template input box. All the resources from your source host will now be available on your destination hosts. Templates can be exported to be used on other organizations, in the same way they can be imported. Check the Templates Documentation for more details.

template

Webhooks

A webhook can be used to perform an action when an event occurs on other website. When that event occurs, the source site makes an HTTP request to the URL configured for the webhook.

To create a webhook (incoming webhook), just go to the Webhooks section left menu, and click on "+ new Incoming webhook". Name it and save it. Once you have saved it, expand it, by clicking over the webhook box, you'll be able to see the URL assigned to the webhook.

webhook expanded

The webhook you created can be used as a trigger for other resources (e.g. You can set the webhook to be the trigger of a task) as shown hereunder.

webhook

Workflow

Workflow connects your tasks together to automate complex or dependent processes.

Which trigger would you like to use? You can start a workflow directly with a play button or you can use monitors or tasks as triggers.

Check the Workflow Documentation for more details.