diff options
Diffstat (limited to 'installer/INSTALL.en.txt')
| -rw-r--r-- | installer/INSTALL.en.txt | 92 |
1 files changed, 75 insertions, 17 deletions
diff --git a/installer/INSTALL.en.txt b/installer/INSTALL.en.txt index a98b7931..23698972 100644 --- a/installer/INSTALL.en.txt +++ b/installer/INSTALL.en.txt @@ -1,37 +1,95 @@ +Installing OpenGnsys Server 1.1.1 (Espeto) +========================================== -Installing and updating OpenGnsys -================================= +Before installation +------------------- +OpenGnsys Server 1.1.1 (codename "Espeto") 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 (read COMPATIBILITY.en.txt for more details). +Network connection is needed in order to download the required packages, the source code and the preconfigured client. -Installing OpenGnsys --------------------- +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 -Run opengnsys_installer.sh script as "root" to install all its dependencies, to install the OpenGnsys components, and to make the initial configuration. +Downloading examples: - sudo bash opengnsys_installer.sh + * Download with wget. + wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh -Follow the instructions. + * Download with curl. + curl https://raw.githubusercontent.com/opengnsys/OpenGnsys/master/installer/opengnsys_installer.sh -o opengnsys_installer.sh -Updating OpenGnsys ------------------- +You must be root to run the installation script: + sudo bash opengnsys_installer.sh -Run opengnsys_update.sh script as "root" to update all OpenGnsys components from the Subversion repository: - sudo bash /opt/opengnsys/lib/opengnsys_update.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. -Follow the instructions. +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 |