source: doc/INSTALL.en.txt

qndtest
Last change on this file was 60d28ed, checked in by Ramón M. Gómez <ramongomez@…>, 15 months ago

#1078: NetBoot uses OpenGnsys symlink to access TFTP directory.

  • Property mode set to 100644
File size: 4.0 KB
Line 
1Installing OpenGnsys Server 1.1.1 (Espeto)
2==========================================
3
4Before installation
5-------------------
6
7OpenGnsys Server 1.1.1 (codename Espeto) is meant to be installed under Ubuntu Server 18.04 LTS or newer (some tests have been done on CentOS 7-based systems).
8
9Network connection is needed in order to download the required packages, the source code and the preconfigured client.
10
11Minimum storage requirements:
12- 100 MB in /tmp (for the installation process)
13- 600 MB in /var/lib/tftpboot (or /srv/tftp on new systems) for every installed ogLive client.
14- 250 MB in the installation folder (/opt/opengnsys) plus 600 MB for every downloaded ISO image.
15- Enough disk space for the image repository in /opt/opengnsys/images (it is recommended to mount it on an independent file system)
16
17
18
19Installing
20----------
21
22To 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/main/installer/opengnsys_installer.sh
23
24Unpacking example:
25        tar xvzf opengnsys-VERSION.tar.gz
26        cd opengnsys/installer
27
28Downloading examples:
29
30    * Download with wget.
31        wget https://raw.githubusercontent.com/opengnsys/OpenGnsys/VERSION/installer/opengnsys_installer.sh
32
33    * Download with curl.
34        curl https://raw.githubusercontent.com/opengnsys/OpenGnsys/VERSION/installer/opengnsys_installer.sh -o opengnsys_installer.sh
35
36
37You must be root to run the installation script:
38        sudo bash opengnsys_installer.sh
39
40
41The 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):
42    * MySQL root password
43    * Web console user and OpenGnsys Super Administrator
44    * Web console user's password
45    * Client's password for accessing remote services
46    * Choose which ogLive clients to install.
47
48The following processes will be carried out:
49    * Gathering of the basic network parameters.
50    * Checking installed packages.
51    * Downloading and installing dependencies.
52    * Creating OpenGnsys basic folder sctructure.
53    * Downloading code from the repository to a temporal folder (/tmp/opengnsys_installer). In upcoming releases this process will not be necessary.
54    * Compiling and installing OpenGnsys services.
55    * Basic configuration of OpenGnsys network services (DHCP, PXE and Samba) using the existing configuration templates.
56    * Copying additional server management files.
57    * Creating database and configuring OpenGnsys administration console web server.
58    * Copying administration console pages.
59    * Copying OpenGnsys client folder structure.
60    * Downloading OpenGnsys client initial image.
61    * Basic configuration of OpenGnsys services using network parameters.
62
63Once the installation process is finished, you can start working with the system:
64    * Configuring DHCP.
65    * Adding information in the administration console.
66    * Customizing administration scripts.
67    * Creating start menus for the clients.
68
69
70
71Updating / upgrading
72--------------------
73
74Warning: if you are going to upgrade OpenGnsys from a version earlier than 1.1.1 (Espeto), you must first upgrade Ubuntu to version 18.04 LTS and restart the server.
75
76There is a system self-upgrading script with the following features:
77    * Network connection is needed to obtain the latest updates / upgrades.
78    * If the script updates itself, then it must be run once again.
79    * Services depending on the operating system will not be updated.
80    * Configuration files will not be modified.
81
82You must be root to run this script:
83    sudo /opt/opengnsys/lib/opengnsys_update.sh
84 
85
86
87Uninstalling
88------------
89
90There is also an uninstallation script to remove the OpenGnsys components:
91    * OpenGnsys files and database will be deleted.
92    * Operating system packages and their configuration files will be preserved.
93    * The image folder and its content will not be deleted.
94
95You must be root to run this script:
96    sudo /opt/opengnsys/lib/opengnsys_uninstall.sh
97
Note: See TracBrowser for help on using the repository browser.