diff options
| -rw-r--r-- | doc/INSTALL.en.txt | 100 | ||||
| -rw-r--r-- | doc/README.en.txt | 67 | ||||
| -rw-r--r-- | installer/INSTALL.en.txt | 45 |
3 files changed, 212 insertions, 0 deletions
diff --git a/doc/INSTALL.en.txt b/doc/INSTALL.en.txt new file mode 100644 index 00000000..3bf0b26f --- /dev/null +++ b/doc/INSTALL.en.txt @@ -0,0 +1,100 @@ + +OpenGnSys Server Installation v. 1.0.3 +====================================== + + +Notes +----- + +It is assumed OpenGnSys Server will be installed in a GNU/Linux distro, Ubuntu 10.04 Server LTS or later, Linux Mint 12 or later, Debian 6 or later. + + +Installation Methods +-------------------- + +There are three basic ways OpenGnSys installation: + + Installation script. Which uses Subversion to download the application. + Starting from a tar.gz This application is now complete. + Installation step by step manual. It is obvious the installation script and install each component. + + +1. Download the Installation Script + +OpenGnSys installation is done by running the installation script opengnsys_installer.sh, which can be downloaded directly from http://www.opengnsys.es/svn/trunk/installer/opengnsys_installer.sh + +1.1. Download the script. Examples with various tools: + + Download with wget. + wget http://www.opengnsys.es/svn/trunk/installer/opengnsys_installer.sh + Download with curl. + curl http://www.opengnsys.es/svn/trunk/installer/opengnsys_installer.sh > opengnsys_installer.sh + Download with a web browser. Click on the link http://www.opengnsys.es/svn/trunk/installer/opengnsys_installer.sh and save the file as opengnsys_installer.sh + +1.2. Or, installation from tar.gz. + + If we do not have access to Subversion, we will have to download the package tgz from the web. Access to http://www.opengnsys.es/browser/tags and load it on a server temporary directory. + + Descompress the file: + tar xvzf opengnsys-version.tar.gz + + Change to the installer directory: + cd opengnsys/installer + + +2. Basic Configuration + + For security reasons, it is very important modify defaults users and passwords to access to the system. For this, edit the installation file opengnsys_installer.sh and change the values of configuration variables: + MYSQL_ROOT_PASSWORD - MySQL root user password. + OPENGNSYS_DB_USER - OpenGnSys access user and OpenGnSys super-user. + OPENGNSYS_DB_PASSWD - User password. + OPENGNSYS_CLIENT_PASSWD - Password for client access to remote services. + + +3. Installation process. + +The installation script must be run as root: + + sudo bash opengnsys_installer.sh + + +4. Check the configuration files. + +Init Configuration + /opt/opengnsys/etc/ogAdmServer.cfg - OpenGnSys Server config file + /opt/opengnsys/etc/ogAdmRepo.cfg - OpenGnSys Repository config file + /opt/opengnsys/etc/ogAdmAgent.cfg - OpenGnSys Agent config file + /opt/opengnsys/client/etc/ogAdmClient.cfg - OpenGnSys Client config file + /opt/opengnsys/www/controlacceso.php - OpenGnSys Web Admin Console config file + +Configure DHCP server, insert clients data and restart the service. + +Access as Administrador in Web Admin Console. + Use the user and password set in the installer to access to database (variables OPENGNSYS_DB_USER and OPENGNSYS_DB_PASSWD). + Check the default organizaed configuration and default user. + Access as user in Web Admin Console. + Use the user and password configured as administrador in the Organizational Unit. + Check the server IP in section "Servidores->Servidor OpenGnSys (Default)". + If you change the configuration, you must to restart the server: sudo /etc/init.d/opengnsys restart + + +Updating OpenGnSys +------------------ + +Run opengnsys_update.sh script as "root" to update all OpenGnSys components from the Subversion repository: + + sudo bash /opt/opengnsys/lib/opengnsys_update.sh + +Follow the instructions. + + +Uninstalling OpenGnSys +---------------------- + +Run opengnsys_uninstall.sh script as "root" to uninstall all OpenGnSys components: + + sudo bash /opt/opengnsys/lib/opengnsys_uninstall.sh + +Follow the instructions. + + diff --git a/doc/README.en.txt b/doc/README.en.txt new file mode 100644 index 00000000..149b600f --- /dev/null +++ b/doc/README.en.txt @@ -0,0 +1,67 @@ + +The OpenGnSys Project README +================================ + +OpenGnSys (pronounced Open Genesis) is based on a modular architecture separated in different service layers which allows its implementation in several educational and organizational IT environments, both in a centralized or distributed way. The main system management 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 under network failure conditions (offline mode). + + +Architecture +------------ + +From the point of view of clients, OpenGnSys Project is constituted by a set of separate modules in different layers of services. + + * The bottom layer is responsible for direct access to client devices and motor functions of cloning. + * An intermediate layer consisting of a set of tools to perform complex tasks and environment customization. + * Management module consists of a simple and intuitive web interface that allows common tasks to manage software distribution to clients. + +Overall, OpenGnSys is a modular system that integrates a set of interrelated components and can be adapted to a variety of work settings possible. These components consist of standard services (file servers, web, database, DHCP, PXE, ...) and custom-developed tools for the project (cloning engine, console web, browser ad hoc, management demons repository and server, ...) which in combination offer everything OpenGnSys system. + + * OpenGnSys Server + Basic service cloning system (DHCP, NFS/Samba, PXE, database, etc..) Necessary for the boot process and initial configuration of the clients. + + * OpenGnSys Administrator + Centralized management web console (web pages, web services, etc.) with support for delegated administration, allowing control of all system components. + + * OpenGnSys Repository Manager + Manager repository of images for each of the administrative units defined in the module OpenGnSys Administrator. There may be one or more modules depending on the model of the organization defined. + + * OpenGnSys Client Agent + Executing agent of orders in the client, which integrates the following features: + - Graphical interface to select options predefined by the administrator. + - Interactive execution of Cloning Engine functions in administrator mode. + - Execution of the tasks sent from the OpenGnSys Administrator module. + + * OpenGnSys Clonning Engine + Motor function libraries cloning, installation and startup of the client operating systems. + + * OpenGnSys Installer + Software installation, upgrade and removal system which includes the settings generator, the clients boot generator, the component package builder, etc. + + +Scenarios +--------- + +OpenGnSys is a modular system that can be used in different scenarios within an Institution, both educational and organizational. + + * Educational Scenarios: OpenGnSys can lend support to some of the educational settings defined by the Working Group-Net Teaching RedIRIS. + + - Classroom teaching: allowing the management and implementation of software installation on the computers of teachers, with ability to customize the settings according to user requirements. + - Classroom teaching ICT Classrooms: implementing methods independent support for PCs of students and teachers. + - Self-learning ICT Classrooms: methods of deployment computers for students, grouped according to the needs identified for each position or for each user profile. + + * Organizational Scenarios: The project can be implemented to provide support in other settings defined in an Institution, such as: + + - Information Services. + - Helpdesk for employment computers. + - Servers Deployment in Data Center. + + +Origins + +OpenGnSys born in May 2009 after the Working Groups RedIRIS held in Malaga as an effort to integrate several projects in development: + + * Brutalix, University of Zaragoza + * Entorno Avanzado de Clonación (EAC), University of Málaga. + * Web Hidra Interface, University of Seville. + + diff --git a/installer/INSTALL.en.txt b/installer/INSTALL.en.txt new file mode 100644 index 00000000..cfff05c5 --- /dev/null +++ b/installer/INSTALL.en.txt @@ -0,0 +1,45 @@ + +Installing and updating OpenGnSys +================================= + + + +Installing OpenGnsys +-------------------- + + +For security reasons, it is very important modify defaults users and passwords to access to the system. For this, edit the installation file opengnsys_installer.sh and change the values of configuration variables: + + MYSQL_ROOT_PASSWORD - MySQL root user password. + OPENGNSYS_DB_USER - OpenGnSys access user and OpenGnSys super-user. + OPENGNSYS_DB_PASSWD - User password. + OPENGNSYS_CLIENT_PASSWD - Password for client access to remote services. + + +Run opengnsys_installer.sh script as "root" to install all its dependencies, to install the OpenGnSys components, and to make the initial configuration. + + sudo bash opengnsys_installer.sh + +Follow the post-installation instructions. + + +Updating OpenGnSys +------------------ + +Run opengnsys_update.sh script as "root" to update all OpenGnSys components from the Subversion repository: + + sudo bash /opt/opengnsys/lib/opengnsys_update.sh + +Follow the instructions. + + +Uninstalling OpenGnSys +---------------------- + +Run opengnsys_uninstall.sh script as "root" to uninstall all OpenGnSys components: + + sudo bash /opt/opengnsys/lib/opengnsys_uninstall.sh + +Follow the instructions. + + |