summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRamón M. Gómez <ramongomez@us.es>2019-05-27 13:54:07 +0200
committerRamón M. Gómez <ramongomez@us.es>2019-05-27 14:11:49 +0200
commitd4e02b28f5455cc47dca40ed28ac03655653d61b (patch)
tree3253ae9825b354ff010e82faa5b5cab6a8f0e7de /doc
parent75a17417ac7b938c0411f5a4c24ce02b115c3638 (diff)
#872: Fix bug in symbolic links.
Diffstat (limited to 'doc')
-rw-r--r--[l---------]doc/INSTALL.en.txt96
-rw-r--r--[l---------]doc/INSTALL.es.txt101
2 files changed, 195 insertions, 2 deletions
diff --git a/doc/INSTALL.en.txt b/doc/INSTALL.en.txt
index c731350b..fac27547 120000..100644
--- a/doc/INSTALL.en.txt
+++ b/doc/INSTALL.en.txt
@@ -1 +1,95 @@
-../installer/INSTALL.en.txt \ No newline at end of file
+Installing OpenGnsys Server 1.1.0
+=================================
+
+Before installation
+-------------------
+
+OpenGnsys Server 1.1.0 is meant to be installed under Ubuntu Server 16.04 LTS or newer, though it has also been tested under operating systems based on CentOS 7.
+
+Network connection is needed in order to download the required packages, the source code and the preconfigured client.
+
+Minimum storage requirements:
+- 100 MB in /tmp (for the installation process)
+- 600 MB in /var/lib/tftpboot (or /srv in Debian systems) for every installed ogLive client.
+- 250 MB in the installation folder (/opt/opengnsys) plus 600 MB for every downloaded ISO image.
+- Enough disk space for the image repository in /opt/opengnsys/images (it is recommended to mount it on an independent file system)
+
+
+
+Installing
+----------
+
+To install OpenGnsys, run opengnsys_installer.sh script after unpacking the release file (opengnsys-release.tar.gz) or after downloading it directly from https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh
+
+Unpacking example:
+ tar xvzf opengnsys-Version.tar.gz
+ cd opengnsys/installer
+
+Downloading examples:
+
+ * Download with wget.
+ wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh
+
+ * Download with curl.
+ curl https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh -o opengnsys_installer.sh
+
+
+You must be root to run the installation script:
+ sudo bash opengnsys_installer.sh
+
+
+The following information will be requested in order to configure the access to the service (a default value will be introduced if no parameter is indicated):
+ * MySQL root password
+ * Web console user and OpenGnsys Super Administrator
+ * Web console user's password
+ * Client's password for accessing remote services
+ * Choose which ogLive clients to install.
+
+The following processes will be carried out:
+ * Gathering of the basic network parameters.
+ * Checking installed packages.
+ * Downloading and installing dependencies.
+ * Creating OpenGnsys basic folder sctructure.
+ * Downloading code from the repository to a temporal folder (/tmp/opengnsys_installer). In upcoming releases this process will not be necessary.
+ * Compiling and installing OpenGnsys services.
+ * Basic configuration of OpenGnsys network services (DHCP, PXE and Samba) using the existing configuration templates.
+ * Copying additional server management files.
+ * Creating database and configuring OpenGnsys administration console web server.
+ * Copying administration console pages.
+ * Copying OpenGnsys client folder structure.
+ * Downloading OpenGnsys client initial image.
+ * Basic configuration of OpenGnsys services using network parameters.
+
+Once the installation process is finished, you can start working with the system:
+ * Configuring DHCP.
+ * Adding information in the administration console.
+ * Customizing administration scripts.
+ * Creating start menus for the clients.
+
+
+
+Updating / upgrading
+--------------------
+
+There is a system self-upgrading script with the following features:
+ * Network connection is needed to obtain the latest updates / upgrades.
+ * If the script updates itself, then it must be run once again.
+ * Services depending on the operating system will not be updated.
+ * Configuration files will not be modified.
+
+You must be root to run this script:
+ sudo /opt/opengnsys/lib/opengnsys_update.sh
+
+
+
+Uninstalling
+------------
+
+There is also an uninstallation script to remove the OpenGnsys components:
+ * OpenGnsys files and database will be deleted.
+ * Operating system packages and their configuration files will be preserved.
+ * The image folder and its content will not be deleted.
+
+You must be root to run this script:
+ sudo /opt/opengnsys/lib/opengnsys_uninstall.sh
+
diff --git a/doc/INSTALL.es.txt b/doc/INSTALL.es.txt
index b4274ba4..7fd679de 120000..100644
--- a/doc/INSTALL.es.txt
+++ b/doc/INSTALL.es.txt
@@ -1 +1,100 @@
-../installer/INSTALL.es.txt \ No newline at end of file
+Instalación de OpenGnsys Server 1.1.0
+=====================================
+
+Notas iniciales
+---------------
+
+Se presupone que el servidor de OpenGnsys 1.1.0 va a ser instalado en una distribución del sistema operativo Ubuntu Server a partir de la versión 16.04 LTS (también ha sido probado en sistemas basados en CentOS 7).
+
+El serividor debe tener acceso a Internet para descargar los paquetes necesarios, el código del proyecto y el cliente preconfigurado.
+
+Requisitos mínimos de almacenamiento:
+- 100 MB en el directorio /tmp (solo durante la instalación)
+- 600 MB en el directorio /var/lib/tftpboot (o /srv en sistemas Debian) por cada cliente ogLive que se desee instalar.
+- 250 MB en el directorio de instalación /opt/opengnsys más 600 MB por cada imagen ISO descargada de clientes ogLive.
+- Estimar la capacidad necesaria para el repositorio de imágenes en /opt/opengnsys/images (es recomendable que este directorio se monte sobre un sistema de archivos independiente).
+
+
+Instalación
+-----------
+
+La instalación de OpenGnsys se realiza ejecutando el script de instalación opengnsys_installer.sh, el cual puede obtenerse descomprimiendo el fichero de la versión opengnsys-Version.tar.gz o descargándolo directamente de la dirección: https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh
+
+Ejemplos de descompresión del programa:
+
+ tar xvzf opengnsys-Version.tar.gz
+ cd opengnsys/installer
+
+Ejemplos de descarga con varias herramientas:
+
+ * Descargar con wget.
+ wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh
+
+ * Descargar con curl.
+ curl https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh -o opengnsys_installer.sh
+
+
+El script de instalación debe ser ejecutado como usuario root:
+ sudo bash opengnsys_installer.sh
+
+
+Dicho script solicitará por teclado la siguiente información para configurar el acceso al servicio (si no se indica un parámetro, toma el valor por defecto):
+ * Clave del usuario root de MySQL.
+ * Usuario de acceso a la consola web y super-administrador de OpenGnsys.
+ * Clave del usuario de acceso a la consola web.
+ * Clave de acceso del cliente a servicios remotos.
+ * Seleccionar cliente(s) ogLive para instalar.
+
+Se realizan los siguientes procesos:
+ * Obtener los parámetros básicos de la red.
+ * Comprobar los paquetes instalados.
+ * Descargar e instalar las dependencias que faltan.
+ * Crear la estructura básica de directorios de OpenGnsys.
+ * Descargar el repositorio de código en un directorio temporal (/tmp/opengnsys_installer). Nota: en versiones futuras este proceso no será necesario.
+ * Compilar e instalar los servicios de OpenGnsys.
+ * Configuración básica de los serviciios de red DHCP, PXE y NFS/Samba a partir de las plantillas de configuración
+ * Copiar ficheros complementarios de gestión del servidor.
+ * Crear la base de datos y configurar el servidor web de OpenGnsys Web Admin Console.
+ * Copiar los ficheros de las páginas de Web Admin Console.
+ * Copiar la estructura de directorios de OpenGnsys Client.
+ * Descargar la o las imágenes iniciales de OpenGnsys Client.
+ * Configuración básica de los serviciios de OpenGnsys a partir de los parámetros de red.
+
+Una vez finalizada la ejecución del instalador, puede empezarse a trabajar con el sistema:
+ * Configurar DHCP.
+ * Añadir datos en la consola de administración.
+ * Personalizar scripts de administración.
+ * Definir menús de inicio para los clientes.
+
+
+
+Actualización
+-------------
+
+Se dispone de un script de auto-actualización del sistema, con las siguientes características:
+ * Es necesario conexión a Internet para obtener las últimas actualizaciones.
+ * Si el script se actualiza a sí mismo, debe ser ejecutado de nuevo.
+ * No se actualizan los servicios asociados al sistema operativo.
+ * No se modifican los ficheros de configuración.
+
+
+El script debe ser ejecutado como usuario root:
+ sudo /opt/opengnsys/lib/opengnsys_update.sh
+
+
+
+Desinstalación
+--------------
+
+También existe un script de desinstalación de los componentes de OpenGnsys, con las siguientes características:
+ * Solicita confirmación para ejecutar sus operaciones.
+ * Se eliminan los ficheros de OpenGnsys y su base de datos.
+ * No se eliminan ni paquetes del sistema operativo ni sus ficheros de configuración.
+ * No se elimina el directorio de las imágenes ni su contenido.
+ * No se eliminan los clientes ogLive ni las plantillas PXE.
+
+
+El script debe ser ejecutado como usuario root:
+ sudo /opt/opengnsys/lib/opengnsys_uninstall.sh
+
+