summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRamón M. Gómez <ramongomez@us.es>2018-06-14 10:31:38 +0200
committerRamón M. Gómez <ramongomez@us.es>2018-06-14 10:31:38 +0200
commite0e4c021382f2c8a66402c545229aa8e528750f9 (patch)
tree8bd47d36d5b7ef6f098beb31aab99e878241f9cd
parenta3a1ff21dde647ae1e3d8d9fc8552e039bcc3022 (diff)
#840: Updating changelog, installation notes and README file.
-rw-r--r--README.md23
-rw-r--r--doc/CHANGELOG.es.txt4
-rw-r--r--doc/INSTALL.en.txt42
-rw-r--r--doc/INSTALL.es.txt4
4 files changed, 50 insertions, 23 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..618df4fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# OpenGnsys
+
+The OpenGnsys Project (pronounced _Open Genesis_) brings together the combined efforts of
+several Spanish Public Universities to provide a number of free and open source tools for
+managing and deploying computers. These tools supply a complete, versatile and intuitive
+system that allows the arrangement, installation and deployment of different operating
+systems.
+
+OpenGnsys is based on a modular architecture separated into different service layers which
+allows its implementation in several educational and organizational IT environments, both
+in a centralized or distributed way. The main management of the system is carried out by
+means of a simple web interface which supports delegated administration. OpenGnsys is also
+suitable for isolated environments, being able to work in network failure conditions
+(offline mode).
+
+OpenGnsys website: https://opengnsys.es/
+
+
+## Installation notes
+
+Please, read installer/README.en.txt (or installer/README.es.txt) for detailled
+instructions.
+
diff --git a/doc/CHANGELOG.es.txt b/doc/CHANGELOG.es.txt
index 3ce47074..9838335b 100644
--- a/doc/CHANGELOG.es.txt
+++ b/doc/CHANGELOG.es.txt
@@ -3,8 +3,8 @@ LISTA DE CAMBIOS CHANGELOG.es.txt
-Lista de cambios incluidos en OpenGnsys 1.1.1
----------------------------------------------
+Lista de cambios incluidos en OpenGnsys 1.1.1 Espeto
+----------------------------------------------------
Tickets resueltos en módulo OpenGnsys Web Admin Console:
#772 Módulo de administración web para dispositivos smartphones y tablets (no se resolverá)
diff --git a/doc/INSTALL.en.txt b/doc/INSTALL.en.txt
index 732ffea4..ef57ea18 100644
--- a/doc/INSTALL.en.txt
+++ b/doc/INSTALL.en.txt
@@ -1,23 +1,25 @@
-Installing OpenGnsys Server v 1.1.1
-===================================
+Installing OpenGnsys Server 1.1.1 (codename "Espeto")
+=====================================================
Before installation
-------------------
-OpenGnsys Server 1.1.1 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.
+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)
-- 450 MB in /var/lib/tftpboot (or /srv in Debian systems)
-- 500 MB in the installation folder (/opt/opengnsys) in addition to the space required for logging (100 MB if ogLive client is already downloaded).
+- 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)
-Installation
-------------
-To install OpenGnsys, run opengnsys_installer.sh 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
+
+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
@@ -41,23 +43,25 @@ The following information will be requested in order to configure the access to
* 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 the installed packages.
+ * Checking installed packages.
* Downloading and installing dependencies.
* Creating OpenGnsys basic folder sctructure.
- * Download the code repository to a temporal folder (/tmp/opengnsys_installer). In upcoming releases this process will not be necessary.
+ * 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 the database and configuring OpenGnsys administration console web server.
- * Copying web administration console pages.
- * Copying the OpenGnsys client folder structure.
+ * 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 is finished you can start working with the system:
+Once the installation process is finished, you can start working with the system:
* Configuring DHCP.
* Adding information in the administration console.
* Customizing administration scripts.
@@ -79,12 +83,12 @@ You must be root to run this script:
-Uninstall
----------
+Uninstalling
+------------
-There is also an uninstall script for the OpenGnsys components:
- * OpenGnsys files and data base will be deleted.
- * Packages belonging to the operating system and their configuration files will be preserved.
+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:
diff --git a/doc/INSTALL.es.txt b/doc/INSTALL.es.txt
index d18bc5c6..280ba648 100644
--- a/doc/INSTALL.es.txt
+++ b/doc/INSTALL.es.txt
@@ -1,5 +1,5 @@
-Instalación de OpenGnsys Server v 1.1.1
-=======================================
+Instalación de OpenGnsys Server 1.1.1 (Espeto)
+==============================================
Notas iniciales
---------------