Simple Panel Web Interfaz simple de usuarios para servicio de hosting, diseño y desarrollo web

Transcripción

1 Simple Panel Web Interfaz simple de usuarios para servicio de hosting, diseño y desarrollo web 1

2 INDICE 1. INTRODUCCIÓN Que es Para que sirve Por que resulta util INSTALACIÓN Licencia Descarga Instalación Configuración CARACTERÍSTICAS Usuarios anónimos Usuarios registrados ESTRUCTURA Sistema de archivos Controladores Modelos Vistas Base de datos SOFTWARE EXTERNO osticket net2ftp Mibew Messenger AUTOR

3 1. Introducción Que es SPanel (Simple Panel) SPanel (Simple Panel) es una aplicación web creada para facilitar la interacción y el mayor aprovechamiento de todas las funcionalidades que ofrece un servicio de hosting, dominio y diseño web para usuarios inexpertos. SPanel no pretende ser un panel de control alternativo a otros ya existentes y muy extendidos, sino que su concepción se basa en proporcionar un numero limitado de herramientas útiles y fáciles de usar para la mayoría de los usuarios inexpertos. El numero de funcionalidades de SPanel es reducido y esta pensado para satisfacer las necesidades mas solicitadas por los usuarios. Para una administración completa de un servicio de hosting, seria necesario además contar con algún panel de control profesional. SPanel puede también ayudar a administrar dominios que están alojados en servidores diferentes y que cuentan con paneles de control también diversos. Para que sirve SPanel proporciona un conjunto de herramientas para administrar servicios asociados con un servicio de hosting, como pueden ser: uso de correo, administración de usuarios, preguntas frecuentes y documentación, acceso por FTP solicitud y gestión de tickets de servicio etc. SPanel esta pensado sobre todo para aquellas empresas que se dediquen a ofrecer a sus clientes servicios de alojamiento web. Porque puede resultar util Si bien existen diversas aplicaciones pensadas para la administración de un servicio de hosting, estas pueden resultar algo complicadas de manejar para usuarios inexpertos. Por poner un ejemplo: Un empresario tiene una pequeña cadena de verdulerías y contrata a una empresa el servicio de hosting y registro de dominios. El primo de este empresario, se encarga de construir un sitio web simple estático que sirva para darse a conocer a cierto numero de personas. Llega un momento, en el 3

4 que el empresario desearía mejorar su sitio web, enviar correo electrónico a sus clientes, conectar su sitio con redes sociales, e incluso lanzar su verdulería online. Para esta clase de personas, interactuar con un panel de control completo, suele resultar confuso y tedioso. Al no encontrar la manera de enviar sus correos o saber porque deben pagar periódicamente y por partes separadas un dominio y un alojamiento, terminaran perdiendo mucho tiempo en o incluso llamadas telefónicas, para que alguien les de la información que necesitan. El objetivo de SPanel es que las principales dudas y los principales servicios que el usuario medio necesita resolver, se encuentren en un solo lugar. 4

5 2. Instalación Licencia SPanel se distribuye bajo la licencia GPL v3 de GNU. Una copia de esta licencia se encuentra en el archivo licencia.txt que esta contenido dentro del paquete de SPanel. Al descargar este producto e instalarlo o utilizarlo, el usuario se compromete a respetar esta licencia y todas las licencias de los productos contenidos en el paquete descargado. Requisitos del servidor Servidor web Apache2 PHP versión 4 o posterior MySQL versión 4 o posterior Descarga Puede descargar el paquete comprimido de SPanel desde la pagina oficial: spanel.com.ar Tan solo debe acceder al sitio spanel.com.ar y hacer click en la pestaña descargas. En esta sección se le mostrara el paquete que puede descargar con la versión mas reciente del programa. Instalación Una vez que descargue el paquete, deberá descomprimirlo y colocarlo en una carpeta a la que tenga acceso su servidor web Apache. Tras descomprimir el paquete deberá darle permisos totales a todos los archivos con el comando: chmod 777 SPanel/ -R Una vez que haya seguido con éxito estos pasos, deberá acceder desde su navegador web preferido a la ruta de su sitio virtual (ej Desde esta pagina se le informara de los pasos a seguir para crear las tablas de la base de datos que usted elija, así como el 5

6 usuario y la contraseña del administrador del sistema. Configuración En caso de que la instalación no se realice de la forma esperada o en caso de que se desee modificar algún comportamiento del programa, es importante tener en cuenta los siguientes archivos: SPANEL En la carpeta /SPanel/application/config: config.php Es uno de los archivos mas importantes para la configuración de codeigniter. En el se determina la ruta del programa, en la variable: $config['base_url']= ' El idioma por defecto: $config['language']= 'spanish'; La clave de encriptación que utilizará la clase encrypt: $config['encryption_key'] = "acm1ptp2sbbackk3vcs"; database.php Contiene la información necesaria para conectarse a la base de datos. Es de vital importancia la correcta configuración de las variables contenidas en este archivo. $db['default']['hostname'] = 'localhost'; $db['default']['username'] = 'usuario'; $db['default']['password'] = 'contraseña'; $db['default']['database'] = 'base_de_datos'; osticket En la carpeta /spanel/ticket/upload/include el archivo ost-config.php Clave de encriptación: 6

7 define('secret_salt','acm1ptp2sbbackk3vcs'); Datos de acceso a la Base de datos: define('dbtype','mysql'); define('dbhost','localhost'); define('dbname','base_de_datos'); define('dbuser','usuario'); define('dbpass','contraseña'); Prefijo de las tablas: define('table_prefix','ost_'); Mibew Messenger En la carpeta /spanel/chat/libs El archivo config.php Ruta de la aplicación: $webimroot = "/spanel/chat"; Parámetros de la Base de datos: $mysqlhost = "localhost"; $mysqldb = "base_de_datos"; $mysqllogin = "usuario"; $mysqlpass = "contraseña"; $mysqlprefix = "chat_"; 7

8 3. Características: Para usuarios Anónimos Preguntas Frecuentes En esta sección se agrupan un conjunto de preguntas que los usuarios de un servicio de hosting. Se muestran agrupadas en dos columnas, la izquierda con las preguntas con identificador impar y la derecha con identificador par. El orden en que se muestran las preguntas viene dado por la columna orden de la tabla sp_preguntas. Si esta establecido, el orden se incrementara en 1 cada vez que algún usuario consulte la respuesta a la pregunta. Las respuestas se encuentran ocultas hasta que se haga click en la pregunta correspondiente Chat Esta sección consiste en un botón para acceder al servicio de chat si no se es un usuario administrador. En caso de ser un usuario administrador, además de poder iniciar una sesión de chat, se proporciona un acceso al panel de administrador del chat. El botón de chat informará al usuario de si existe un agente disponible para contestar los mensajes o no. Por defecto, el servicio de chat de SPanel hace uso de una herramienta libre externa: mibew messenger sobre la que encontrara mas información mas adelante en este manual. Tickets de servicio Se proporciona al usuario un simple formulario que envía la solicitud para crear un nuevo ticket de soporte, es procesado por una utilidad y la respuesta es mostrada desde el panel haciendo uso de la tecnología AJAX. Esto creará un nuevo ticket de servicio que será manejado por los administradores del sistema. 8

9 En caso de ser un usuario administrador, se contará además con un acceso al panel de administración del sistema de tickets de servicio. Por defecto SPanel hace uso de una herramienta externa para ofrecer esta utilidad. Dicha herramienta es el aclamado sistema de tickets de servicio osticket, del que se proporcionara mas información mas adelante Guía De manera similar a la utilizada por las preguntas frecuentes, la GUIA cuenta con dos columnas en las que se mostraran una lista de manuales, preferentemente en PDF en la columna izquierda y un conjunto de videos explicativos o tutoriales en la columna de la derecha. Solucionador de problemas Esta utilidad esta pensada para resolver en unos pocos pasos los problemas mas frecuentes que se encuentra un usuario del sistema. Su uso por parte de los usuarios es tan simple como presionar el botón siguiente a cada paso mientras la solucion al problema planteado no sea resuelta. Para usuarios registrados Manejo de s Este elemento de SPanel esta pensado para todos aquellos usuarios que, o bien desconocen la posibilidad de utilizar una cuenta de correo con el nombre de su dominio haciendo uso de un servidor de correo instalado en su servidor, o bien no saben exactamente como utilizarlo. Desde el panel de , el usuario puede crear el nombre de sus remitentes, guardar sus contactos, cargar plantillas que den formato HTML a sus envíos, ver los correos enviados, acceder a aplicaciones externas asociadas al servicio de correo electrónico como el webmail (roundcube por ejemplo) o listas de correo 9

10 como phplist Por defecto, los s se enviaran haciendo uso del servidor de correo existente en el mismo servidor donde se encuentre la instalación de spanel. Para utilizar una plantilla, esta deberá ser seleccionada para cargarse por el programa desde el formulario agregar plantilla. Deberá estar en formato php y su peso no excederá los 10kb. Las plantillas subidas correctamente se almacenaran en la carpeta /spanel/application/views/plantillas Editor de contenidos En caso de ser un usuario administrador, el editor de contenidos cuenta con una pestaña Menú y tantas pestañas como elementos de menu existan en el sistema. Desde la pestaña menu, se pueden editar, insertar o eliminar nuevos elementos al menu, haciendo que SPanel sea fácilmente escalable según las necesidades de cada empresa. Al insertar un nuevo elemento de menu, se creara automáticamente un controlador, un modelo y una vista llamadas como el nuevo elemento (con una M delante en el caso del modelo) y aparecerá un nuevo elemento en el menu principal, al igual que en el actual menu de edición 10

11 Los elementos a editar por defecto son aquellos que se corresponden con las características a las que hace referencia este capitulo. En la sección editar FAQ se podrán modificar insertar o eliminar los elementos que forman parte de las preguntas frecuentes. 11

12 Las demás secciones permiten editar de la misma manera los elementos que forman parte de cada utilidad de SPanel. Hay que destacar la sección , desde donde se configurará el acceso a servicios de correo externos, de la misma forma que la sección FTP guarda los datos relacionados con usuarios y contraseñas requeridas para el acceso al servicio FTP de los dominios a los que se hace referencia. Tanto las contraseñas de los servicios de correo externos, como las de los usuarios de servidores FTP se almacenan en la base de datos (en las tablas sp_ y sp_ftp, respectivamente) cifradas con la clave de encriptación de codeigniter. La pestaña editar servirá para configurar lo que se mostrara en esta sección cuando el usuario no es administrador. Cuando un usuario no administrador acceda al elemento EDITAR del menu de SPanel, dispondrá de las herramientas necesarias para gestionar los contenidos del sitio web que haya seleccionado. Estadísticas Este elemento de SPanel muestra un conjunto de estadísticas recopiladas por el servicio de Google Analytics en widgets creados por Seethestats. Las estadísticas a mostrar están relacionadas con el usuario conectado y el dominio seleccionado, en caso de que hayan sido configuradas adecuadamente. 12

13 Manejo de usuarios Este elemento esta dedicado a la gestión de los usuarios del sitio web seleccionado y relacionados con el usuario de SPanel, en caso de haber sido configurado correctamente. Los usuarios administradores de SPanel podrán desde este elemento de menu administrar los demás usuarios de SPanel, así como los diferentes dominios asociados a cada usuario. Social Este elemento esta diseñado para administrar la presencia del sitio web seleccionado en diferentes redes sociales. Entre sus utilidades se encuentra un creador de diferentes botones de redes sociales como google + o twitter que se pueden agregar al código html de cualquier pagina web. 13

14 Gestor de archivos Este elemento proporciona un acceso rápido al servidor FTP del sitio web seleccionado relacionado con el usuario de SPanel correspondiente, siempre que haya sido configurado adecuadamente. Para proporcionar esta utilidad, SPanel hace uso de una herramienta externa, en este caso net2ftp, de la cual recibirá mas información mas adelante. 14

15 4. Estructura SPANEL esta desarrollado en Codeigniter, un framework basado en Modelo Vista Controlador. Codeigniter es un poderoso entorno de trabajo en PHP, pensado para crear aplicaciones web de manera intuitiva avalado por una gran comunidad de usuarios. Para mas información puede acceder al sitio web oficial codeigniter.com Archivos y carpetas que componen SPanel: application chat Contiene los modelos vistas y controladores creados en codeigniter Contiene el programa de chat mibew messenger licencia.txt css Copia de la licencia GPL v3 Hojas de estilo del programa favicon.ico ftp guia Icono de SPanel para ser mostrado en el navegador Contiene el programa net2ftp Lugar donde deben almacenarse todos aquellos archivos que forman parte de la sección GUIA de SPanel, sean estos archivos de texto, PDF o eventualmente videos 15

16 images Lugar donde se almacenan las imágenes que usa SPanel, como los iconos de los menús, el isotipo de SPanel, iconos de otros productos que se integran en SPanel index.php js Define el entorno de trabajo de codeigniter Esta carpeta contiene los archivos javascript necesarios para el correcto funcionamiento de SPanel. Entre estos archivos se encuentra la librería externa JQUERY (jquery.js) creada en su origen por John Resig y que se distribuye con licencia GPL. Cambien se incluye el plugin jquery-form que facilita el envío de formularios usando tecnología AJAX license.txt system ticket Licencia del producto codeigniter Archivos del sistema codeigniter necesarios para su funcionamiento Carpeta que contiene el programa osticket, que gestiona el sistema de tickets de servicio que utiliza el elemento TICKET de SPanel VERSION.txt Versión de SPanel. En el momento de la redacción de este documento, la versión de SPanel es la , ,

17 Controladores Resultaría repetitivo describir uno a uno cada controlador, cuando en su mayoría se encargan de mostrar su vista homónima realizando las llamadas a las tablas de la base de datos homónimas precedidas por el prefijo sp_ utilizando para ello el modelo correspondiente. Por ello se procederá a su listado, haciendo una breve descripcion en caso de que el controlador sea de mayor importancia. chat.php editar.php Este es uno de los controladores mas complejos, ya que su cometido es gestionar la edición de los elementos que conforman SPanel utilizando el modelo Meditar.php .php estadisticas.php faq.php ftp.php guia.php index.php Este es el controlador que SPanel utiliza por defecto y por tanto es el mas importante de todos. Se encarga también de la entrada de usuarios en el sistema, sirviéndose del modelo Madmins.php para consultar la base de datos sp_users. Si la entrada en el sistema es exitosa, se crean diferentes variables de sesión que almacenan el nombre del usuario, los dominios relacionados con la id del usuario, el dominio actualmente seleccionado, y una variable para mostrar mensajes al ejecutar acciones. inicio.php login.php panel.php plantilla.php pregunta.php social.php 17

18 solucionador.php ticket.php usuarios.php Modelos madmins.php Se encarga de la entrada de usuarios en el sistema. Usa la tabla sp_users de la base de datos mdominios.php Carga la relación de usuarios-dominios del sistema. Usa la tabla sp_users y sp_dominios de la base de datos meditar.php Se encarga de hacer una llamada para mostrar todos los elementos de menu y gestiona toda la edición de contenidos realizada por los administradores del sistema. Es el modelo mas complejo de los existentes, ya que hace llamadas a todas las tablas de la base de datos según se le requiera m .php Carga los elementos necesarios para poder utilizar el elemento del menu principal. Usa las tablas sp_ , sp_ _contactos, sp_ _guardados, sp_ _plantillas, y sp_ _remitentes mestadisticas.php Selecciona los elementos de la tabla sp_estadísticas mfaq.php Selecciona los elementos de la tabla sp_faq mftp.php 18

19 Selecciona los elementos de la tabla sp_ftp mguia.php Selecciona los elementos de la tabla sp_guia mmenu.php Selecciona los elementos de la tabla sp_menu, que almacena todos los elementos del menu de SPanel mnoticias.php Selecciona los elementos de la tabla sp_noticias msolucionador.php Selecciona los elementos de las tablas sp_solucionador_problemas y sp_solucionador_soluciones musuarios.php Vistas Selecciona los elementos de la tabla sp_usuarios y se encarga de la inserción, modificación o eliminación de los usuarios del sistema. Describir una por una todas las vistas existentes no resulta demasiado provechoso. En su lugar hay que destacar las vistas principales del programa. 19

20 central.php Muestra la sección central, con fondo blanco, que a su vez contiene la vista navigation.php que muestra los iconos de menu y la vista que se llame desde el controlador bajo la variable $main, que es el contenido principal de cada elemento del menu. chat.php editar_chat.php editar_editar.php editar_ .php editar_estadisticas.php editar_faq.php editar_ftp.php editar_guia.php editar.php editar_social.php editar_solucionador.php editar_ticket.php editar_usuarios.php .php estadisticas.php 20

21 faq.php footer.php Muestra un conjunto de imágenes PNG como elemento ultimo elemento horizontal en la pagina del navegador. ftp.php guia.php header.php inicio.php login.php navigation.php Muestra los iconos de navegación del menu principal. panel.php plantilla.php social.php solucionador.php template.php La vista principal. Las demás vistas están contenidas dentro de ella, siendo top, central y footer las cargadas por defecto. ticket.php top.php Muestra el panel superior, donde aparecen los botones de ir a inicio, conectarse/desconectarse y el seleccionador de dominios para los usuarios registrados. usuarios.php Base de Datos Elementos externos osticket (ost_) ost_api_key ost_config ost_department 21

22 ost_ ost_ _banlist ost_ _template ost_groups ost_help_topic ost_kb_premade ost_staff ost_syslog ost_ticket ost_ticket_attachment ost_ticket_lock ost_ticket_message ost_ticket_note ost_ticket_priority ost_ticket_response ost_timezone Mibew (chat_) chat_chatban chat_chatconfig chat_chatgroup chat_chatgroupoperator chat_chatmessage chat_chatoperator chat_chatresponses chat_chatrevision chat_chatthread Tablas Internas (sp_) sp_dominios: Esta tabla alberga el nombre de los dominios registrados asociados con el id del usuario correspondiente. Tiene los campos: dominioid dominionombre usuarioid sp_ 22

23 Esta tabla tiene como propósito almacenar información adicional relacionada con el correo electrónico, como por ejemplo la ruta para acceder a webmail (si esta existiese). Tiene los campos: id dominionombre url nombre usuarioid user pass sp_ _contactos Esta tabla almacena información sobre los contactos relacionados con un usuario. Tiene los campos: id nombre usuarioid sp_ _guardados Esta tabla contiene el conjunto de los s enviados por un usuario determinado. Tiene los campos: guardadoid remitente destinatario bcc asunto contenido fecha usuarioid 23

24 sp_ _plantillas Esta tabla contiene la referencia a las plantillas de cada usuario del sistema, que se almacenan en la carpeta /spanel/application/views/plantillas Tiene los campos: plantillaid nombre ruta usuarioid sp_ _remitentes Esta tabla tiene las entidades remitentes del correo saliente Tiene los campos: id_remitente nombre usuarioid sp_estadísticas Esta tabla tiene una relación de dominios, usuarios y ruta de estadísticas proporcionada por seethestats. Tiene los campos: estadisticaid domain userid url sp_faq Esta tabla almacena las preguntas frecuentes y sus respuestas. Tiene los campos: id_pregunta pregunta 24

25 respuesta idioma orden sp_ftp Esta tabla tiene información sobre el servidor FTP relacionado con un dominio y un usuario. El campo pass contiene la contraseña del servidor cifrada con la clave de encriptacion de la clase encrypt de codeigniter Sus campos son: ftpid usuarioid dominionombre user pass sp_guia Esta tabla contiene la ruta hacia los documentos que componen el centro de conocimientos mostrado por el elemento GUIA del menu principal. Sus campos son: guiaid nombre contenido idioma descripcion tipo sp_menu Esta tabla contiene el nombre y la descripcion de todos los elementos que conforman el menu principal de SPanel. Contiene los campos id_menu titulo 25

26 descripcion idioma publico orden sp_noticias Esta tabla contiene noticias mostradas en la pagina principal de SPanel. Los campos que la componen son los siguientes noticiasid titulo desarrollo fecha sp_solucionador_problemas Esta tabla contiene los problemas a los que hace referencia la sección solucionador de problemas del menu principal. Esta relacionada con la tabla sp_solucionador_soluciones. Los campos que la forman son: problemaid nombre descripcion idioma sp_solucionador_soluciones Esta tabla almacena las soluciones relacionadas con los problemas descritos en la tabla anterior. Sus campos son solucionid problemaid solucion idioma orden sp_users 26

27 Esta es quizá la tabla mas importante de toda la base de datos que conforma SPanel, ya que almacena todos los datos de los usuarios del sistema. Las contraseñas de los usuarios se almacenan cifradas. Esta formada por los siguientes campos: id username status password administrador Internacionalización Además de contar con campos específicos en la base de datos que albergan información sobre el idioma de cada entrada contenida en esta, SPanel hace uso de la librería de lenguaje Internationalization (i18n) para codeigniter que facilita la traducción del programa. En la carpeta /spanel/application/language existen subcarpetas llamadas como cada idioma (por ejemplo english) que contienen un archivo global_lang.php con variables referentes a palabras y su traducción 27

28 5. Software externo SPANEL incluye entre sus utilidades elementos de software externos, respetando sus licencias. Para mas información sobre el software externo no tiene mas que buscar información en internet. Mibew messenger Es un completo servicio de chat basado en PHP y Mysql desarrollado específicamente para la comunicación entre clientes y aquellas empresas que ofrecen servicios relacionados con internet. osticket Se trata de un sistema de tickets de soporte de uso muy extendido y de código abierto. Integra sin problemas las preguntas creadas a través de correo electrónico, teléfono o basadas en formularios Web con una interfaz web multiusuario. simple y fácil de usar. Gestiona, organiza y archiva todas las solicitudes de apoyo y sus respuestas en un solo lugar mientras que proporciona a sus clientes la capacidad de respuesta que se merecen. Net2ftp (Ftp desde navegador web) net2ftp es un cliente FTP basado en web y escrito en PHP. Permite acceder a un servidor FTP fácilmente desde un navegador web. Seethestats y Google Analytics (Estadísticas) Google Analytics es, con diferencia, la herramienta mas utilizada para conseguir estadísticas de todo tipo sobre paginas web. Seethestats es una aplicación que permite generar widgets que muestren la información recopilada por Analytics mediante la simple adición de código html basado en iframes en el lugar deseado. Para realizar esta tarea, es necesario contar con una cuenta de usuario en Google Analytics, insertar el código de seguimiento en las paginas web deseadas, y una en seethestats con privilegios de acceso a la primera. 28

29 6. Acerca del autor Sebastian Porteiro es Técnico Superior en Administración de Sistemas Informáticos en Red JUNIO