summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRamón M. Gómez <ramongomez@us.es>2018-10-04 10:55:02 +0200
committerRamón M. Gómez <ramongomez@us.es>2018-10-04 10:55:02 +0200
commitea01a0db9f0d19f6f87a4c26de3679e5cc634e3f (patch)
tree6ebca53c27bd1e1789276450903e1ebe86e75ee9
parent623659e5c4696e54e009591a8d81dde2ea559805 (diff)
#872: Updating installation info (devel branch).
-rw-r--r--README.md2
l---------[-rw-r--r--]doc/INSTALL.en.txt97
l---------[-rw-r--r--]doc/INSTALL.es.txt101
-rw-r--r--installer/INSTALL.en.txt92
-rw-r--r--installer/INSTALL.es.txt108
-rw-r--r--installer/README.en.txt25
-rw-r--r--installer/README.es.txt12
7 files changed, 188 insertions, 249 deletions
diff --git a/README.md b/README.md
index 0c5141a3..bac23ac6 100644
--- a/README.md
+++ b/README.md
@@ -18,5 +18,5 @@ OpenGnsys website: https://opengnsys.es/
## Installation notes
-Please, read `doc/INSTALL.en.txt` (or `doc/INSTALL.es.txt`) for detailled instructions.
+Please, read `installer/INSTALL.en.txt` (or `installer/INSTALL.es.txt`) for detailled instructions.
diff --git a/doc/INSTALL.en.txt b/doc/INSTALL.en.txt
index ef57ea18..c731350b 100644..120000
--- a/doc/INSTALL.en.txt
+++ b/doc/INSTALL.en.txt
@@ -1,96 +1 @@
-Installing OpenGnsys Server 1.1.1 (codename "Espeto")
-=====================================================
-
-Before installation
--------------------
-
-OpenGnsys Server 1.1.1 (Espeto) is mean 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) o downloading it directly from https://raw.githubusercontent.com/opengnsys/OpenGnsys/devel/installer/opengnsys_installer.sh
-
-Unpacking example:
- tar xvzf opengnsys-1.1.0.tar.gz
- cd opengnsys/installer
-
-Download examples:
-
- * Download with wget.
- wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/devel/installer/opengnsys_installer.sh
-
- * Download with curl.
- curl https://raw.githubusercontent.com/opengnsys/OpenGnsys/devel/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.
- * Download 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
-
+../installer/INSTALL.en.txt \ No newline at end of file
diff --git a/doc/INSTALL.es.txt b/doc/INSTALL.es.txt
index 280ba648..b4274ba4 100644..120000
--- a/doc/INSTALL.es.txt
+++ b/doc/INSTALL.es.txt
@@ -1,100 +1 @@
-Instalación de OpenGnsys Server 1.1.1 (Espeto)
-==============================================
-
-Notas iniciales
----------------
-
-Se presupone que el servidor de OpenGnsys 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/devel/installer/opengnsys_installer.sh
-
-Ejemplos de descompresión del programa:
-
- tar xvzf opengnsys-1.1.0.tar.gz
- cd opengnsys/installer
-
-Ejemplos de descarga con varias herramientas:
-
- * Descargar con wget.
- wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/devel/installer/opengnsys_installer.sh
-
- * Descargar con curl.
- curl https://raw.githubusercontent.com/opengnsys/OpenGnsys/devel/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
-
-
+../installer/INSTALL.es.txt \ No newline at end of file
diff --git a/installer/INSTALL.en.txt b/installer/INSTALL.en.txt
index a98b7931..fac27547 100644
--- a/installer/INSTALL.en.txt
+++ b/installer/INSTALL.en.txt
@@ -1,37 +1,95 @@
-
-Installing and updating OpenGnsys
+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.
-Installing OpenGnsys
---------------------
+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
-Run opengnsys_installer.sh script as "root" to install all its dependencies, to install the OpenGnsys components, and to make the initial configuration.
+Unpacking example:
+ tar xvzf opengnsys-Version.tar.gz
+ cd opengnsys/installer
- sudo bash opengnsys_installer.sh
+Downloading examples:
-Follow the instructions.
+ * 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
-Updating OpenGnsys
-------------------
-Run opengnsys_update.sh script as "root" to update all OpenGnsys components from the Subversion repository:
+You must be root to run the installation script:
+ sudo bash opengnsys_installer.sh
- sudo bash /opt/opengnsys/lib/opengnsys_update.sh
-Follow the instructions.
+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.
-Uninstalling OpenGnsys
-----------------------
+You must be root to run this script:
+ sudo /opt/opengnsys/lib/opengnsys_update.sh
+
-Run opengnsys_uninstall.sh script as "root" to uninstall all OpenGnsys components:
- sudo bash /opt/opengnsys/lib/opengnsys_uninstall.sh
+Uninstalling
+------------
-Follow the instructions.
+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/installer/INSTALL.es.txt b/installer/INSTALL.es.txt
index 0fd5ba75..e585a507 100644
--- a/installer/INSTALL.es.txt
+++ b/installer/INSTALL.es.txt
@@ -1,54 +1,100 @@
-Instalación y Actualización de OpenGnsys 1.1.1pre
-=================================================
+Instalación de OpenGnsys Server 1.1.0
+=====================================
+Notas iniciales
+---------------
-Instalación inicial
--------------------
+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).
-1. Obtener el instalador.
+El serividor debe tener acceso a Internet para descargar los paquetes necesarios, el código del proyecto y el cliente preconfigurado.
-Descargar una versión completa y desccomprimir el fichero "opengnsys-version.tar.gz":
- tar xvzf opengnsys-version.tar.gz
- cd opengnsys/installer
+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).
-O bien, descargar el instalador desde la última reversión del repositorio:
- wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/devel/installer/opengnsys_installer.sh
-Opcionalmente, puede descargarse la imagen del cliente; si no se realiza este paso, el instalador la descargará automáticamente.
- wget https://opengnsys.es/downloads/ogLive-versioncliente.iso
+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/devel/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
-2. Ejecutar el instalador como 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.
+ * 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.
-Actaulización de ficheros
--------------------------
+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.
-Ejecutar el script de actualización como usuario root:
- sudo /opt/opengnsys/lib/opengnsys_update.sh
-Notas importantes.
-1. Es necesario conexión a Internet para obtener las últimas actualizaciones.
-2. Si el script se actualiza a sí mismo, pedirá automáticamente que vuelva a ser ejecutado para terminar de actualizar todo el sistema.
-3. El programa de actualización no modifica ficheros de configuración, no actualiza la bases de datos y no modifica ficheros de imágenes.
+Actualización
+-------------
-Desinstalar OpenGnsys
----------------------
+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.
-Ejecutar el script de actualización como usuario root:
- sudo /opt/opengnsys/lib/opengnsys_uninstall.sh
-Notas importantes.
-1. Para poder conservar la información, es recomendable hacer copia de seguridad del servidor antes de desinstalar.
-2. Se solicita confirmación por parte del usuario antes de ejecutar cualquier operación.
-3. El programa de desinstalación no elimina los ficheros de imágenes, ni los clientes ogLive instalados, no desinstala ningún paquete del sistema operativo incluido en el proceso de instalación y no detiene, ni desconfigura ningún otro servicio auxiliar a OpenGnsys.
+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
+
diff --git a/installer/README.en.txt b/installer/README.en.txt
new file mode 100644
index 00000000..277040da
--- /dev/null
+++ b/installer/README.en.txt
@@ -0,0 +1,25 @@
+
+OpenGnsys Installer README
+===============================
+
+
+This directory contains documentation and maintenance scripts for installing,
+updating and uninstalling an OpenGnsys Server.
+
+
+- INSTALL.en.txt installation information (English)
+- INSTALL.es.txt installation information (Spanish)
+- LICENSE.en.txt licence information (English)
+- ogagentpkgs-Version.tar.gz agent for operationg systems (OGAgent)
+- opengnsys_export.sh script to export data to another OpenGnsys Server
+- opengnsys_import.sh script to import data from another OpenGnsys Server
+- opengnsys_installer.sh installation script
+- opengnsys_uninstall.sh uninstallation script
+- opengnsys_update.sh updating script
+
+- opengnsys_makecompress.sh script to generate a compress file with our last release
+- ogagent-devel-installer.sh script to prepare OGAgent compillation environment
+
+- vagrant Vagrant configuration directory to deploy some virtual
+ environments
+
diff --git a/installer/README.es.txt b/installer/README.es.txt
index a7879033..0642e4ed 100644
--- a/installer/README.es.txt
+++ b/installer/README.es.txt
@@ -7,14 +7,18 @@ Este directorio contiene la documentación y los programas para instalar, actual
eliminar el Proyecto OpenGnsys.
-- INSTALL.es.txt información de instalación y desinistalación
-- LICENSE.en.txt información de licencia de uso
+- INSTALL.en.txt información de instalación y desinistalación (inglés)
+- INSTALL.es.txt información de instalación y desinistalación (español)
+- LICENSE.en.txt información de licencia de uso (inglés)
+- ogagentpkgs-Version.tar.gz agentes para sistemas operativos (OGAgent)
+- opengnsys_export.sh programa para exportar datos a otro servidor OpenGnsys
+- opengnsys_import.sh programa para importar datos desde otro servidor OpenGnsys
- opengnsys_installer.sh programa de instalación del serviidor
-- opengnsys_makecompress.sh programa para descargar la última revisión del proyecto
- y generar un fichero comprimido
- opengnsys_uninstall.sh programa de desinstalación del serviidor
- opengnsys_update.sh programa de actualización del serviidor
+- opengnsys_makecompress.sh programa para descargar la última revisión del proyecto
+ y generar un fichero comprimido
- ogagent-devel-installer.sh programa de preparación del entorno de desarrollo y
compilación de agentes OGAgent para sistemas operativos