Se añaden traducciones

Se ajusta mkdocs
Se ajustan direcciones de imágenes pra poner la raiz del proyecto
/assets
main
Angel Rodriguez 2025-05-23 00:45:25 -06:00
parent 86ef75c5c6
commit 445623dc07
6 changed files with 208 additions and 41 deletions

View File

@ -2,11 +2,11 @@
## Introduction
Welcome to the new OpenGnsys administration interface. This manual will guide you through your first steps in setting up and efficiently using the platform. The new web console represents a qualitative leap with the following main features
Welcome to the new OpenGnsys administration interface. This manual will guide you through your first steps to configure and use the platform efficiently. The new web console represents a qualitative leap with the following main features
!!! info
- Developed with Angular 18, a modern and up-to-date framework
- Responsive web design that works both on PC environments and mobile devices
- Responsive web design that works on both desktop and mobile devices
- Multilingual support with English translation
## System Access
@ -14,7 +14,7 @@ Welcome to the new OpenGnsys administration interface. This manual will guide yo
To start using OpenGnsys
1. Open your preferred web browser
2. Enter the URL of the OpenGnsys server
2. Enter the OpenGnsys server URL
3. On the login screen, enter your credentials (username and password)
Click on "Log In"
@ -25,11 +25,11 @@ Click on "Log In"
Once inside, you will find:
- **Side navigation panel**: Access to all modules and functionalities
- **Sidebar navigation panel**: Access to all modules and functionalities
- **Top bar**: User information, notifications, and quick access to settings
- **Central workspace**: Where the selected information is displayed and managed
![Consola Web OpenGnsys](../assets/images/screenshots/ogintro-webconsole.png)
![OpenGnsys Web Console](../assets/images/screenshots/ogintro-webconsole.png)
## Initial Configuration
@ -37,36 +37,36 @@ Once inside, you will find:
User management allows you to control who has access to the system and what they can do.
![Menú de configuración](../assets/images/screenshots/oggui-config_menu.png)
![Configuration menu](../assets/images/screenshots/oggui-config_menu.png)
#### Viewing Existing Users
#### View Existing Users
Go to **Administration > Users** to view the list of current system users.
Go to **Administration > Users** to see the list of current system users.
![Lista de usuarios](../assets/images/screenshots/oggui-config_usuarios.png)
![User list](../assets/images/screenshots/oggui-config_usuarios.png)
#### Adding a New User
#### Add a New User
1. On the Users page, click the "Add Users" button
1. On the Users page, click the "Add users" button
2. Complete the form with the following data:
![Añadir usuario](../assets/images/screenshots/oggui-administracion-usuarios-anadir_usuario.png)
![Add user](../assets/images/screenshots/oggui-administracion-usuarios-anadir_usuario.png)
- **Username**: Unique identifier for logging in
- **Password**: Access key (note: only administrators can change passwords)
- **Role**: Select one or more roles that will define the user's permissions
- **Organizational Unit**: Defines which groups of classrooms or machines the user will be able to administer
- **Organizational Unit**: Defines which classroom groups or machines the user can manage
3. Click "Save" to create the new user
#### Editing an Existing User
#### Edit an Existing User
1. In the user list, locate the user you want to edit
2. Click the edit icon (pencil)
3. Update the necessary fields
4. Save the changes
#### Deleting a User
#### Delete a User
1. In the user list, locate the user you want to delete
2. Click the delete icon (trash can)
@ -74,49 +74,49 @@ Go to **Administration > Users** to view the list of current system users.
### Role Configuration
Roles define the permissions of users on the platform. OpenGnsys includes four predefined levels:
Roles define user permissions on the platform. OpenGnsys includes four predefined levels:
- **Super Admin**: Full control of the platform, without restrictions
- **Organizational Unit Admin**: Full control over the assigned organizational unit
- **Super Administrator**: Full control of the platform, no restrictions
- **Organizational Unit Administrator**: Full control over the assigned organizational unit
- **Organizational Unit Operator**: Limited permissions to operate machines in the assigned unit
- **User**: Basic access to the platform
### Environment Variables
Environment variables define the connection configuration with the different components:
Environment variables define the connection configuration to the different components:
1. Go to **Administration > Environment Variables**
2. Configure the following variables according to your infrastructure:
- **OG_CORE_IP**: IP address of the main server
- **OG_DHCP_API_URL**: URL of the DHCP service API
- **OG_BOOT_API_URL**: URL of the boot server API
- **OG_LOG_IP**: IP address of the log server
- **OG_DHCP_API_URL**: DHCP service API URL
- **OG_BOOT_API_URL**: Boot server API URL
- **OG_LOG_IP**: Logging server IP address
- **REMOTEPC_AUTH_LOGIN**: Authentication URL for RemotePC
- **REMOTEPC_AUTH_USERNAME**: Username for RemotePC
- **REMOTEPC_AUTH_PASSWORD**: Password for RemotePC
- **REMOTEPC_URL**: Base URL of the RemotePC service
- **SSL_ENABLED**: true or false.
- **SSL_ENABLED**: true or false
![oggui-administracion-env.png](../assets/images/screenshots/oggui-administracion-env.png)
!!! note "Note"
The UDS_ variables will appear as REMOTEPC_ in your installation
UDS_ variables will appear as REMOTEPC_ in your installation
## Navigating the Menus
## Menu Navigation
The left side panel contains all available menus according to your role and the active modules:
The left sidebar contains all available menus based on your role and the active modules:
- **Groups**: Management of groups
- **Actions**: The management module for Actions, Commands, and Tasks.
- **Subnets**: The management module for the DHCP service.
- **Boot**: The management module for the ogLive and PXE boot services.
- **Calendars**: Module for managing machine availability in the RemotePC service
- **Repositories**: Module for managing repositories and the images associated with each.
- **Menus**: Allows managing the menus that will be displayed when starting ogLive on a client machine.
- **Groups**: Group management
- **Actions**: Actions, Commands, and Tasks management module
- **Subnets**: DHCP service management module
- **Boot**: Management module for ogLive and PXE boot services
- **Calendars**: Module to manage machine availability in the RemotePC service
- **Repositories**: Module to manage repositories and their associated images
- **Menus**: Allows managing the menus displayed when launching ogLive on a client machine
!!! note "Note"
Some modules may not be available if they depend on external services that are not configured. For example, if the DHCP service is managed externally, accessing that menu will display a notice indicating that the module is not enabled.
Some modules may not be available if they depend on external services that are not configured. For example, if the DHCP service is managed externally, accessing that menu will display a message indicating that the module is not enabled.
--8<-- "sections/oggui-grupos.md"
--8<-- "sections/oggui-acciones.md"

View File

@ -0,0 +1,11 @@
## Action Management
To work with Actions:
1. Go to the **Actions** menu
2. From here you can:
- Manage Commands
- Execute Command Groups
- Execute Tasks

View File

@ -0,0 +1,28 @@
## Common Troubleshooting
### Access Issues
If you cannot access the system:
- Verify that the credentials are correct
- Check connectivity with the server
- Contact the administrator to verify your permissions
### Modules Unavailable
If a module appears as unavailable:
- Ensure the corresponding service is active
- Check the related environment variables
- Review the system logs to identify potential errors
## Additional Resources
[Community Forum][foro-url]{target=\_blank}
[foro-url]: https://foro.opengnsys.es
[Development Git Repository][git-url]{target=\_blank}
[git-url]: https://dev.opengnsys.es/gitea
---
This manual has provided you with the basic knowledge to begin using the OpenGnsys administration interface. For more detailed information on specific features, consult the full documentation or contact technical support.

View File

@ -0,0 +1,129 @@
## Hierarchical Containment Structure
The logical schema of OpenGnsys offers elements to organize computer equipment in a simplified hierarchical containment structure, as well as user control to access the schema or part of it.
The new hierarchical structure has been significantly simplified, now based on two main elements: **Organizational Units (Groups)** and **Clients (Workstations)**.
- **Organizational Units (Groups):**
Groups can be of any type according to organizational needs, allowing a completely flexible and adaptable structure for any organizational context.
- **Clients (Workstations):**
These represent the individual machines that will be managed by OpenGnsys.
This simplified structure enables greater organizational flexibility, conceptually adapting to any type of situation. For example, isolated workstations in different geographical locations can be efficiently grouped into a specific "client group," facilitating centralized management.
One of the main elements for organization remains the **organizational unit**. Its primary function is to group objects for administrative purposes and enable delegation of authority.
Delegation allows for the administration of a large number of centers, departments, or laboratories to be distributed among a group of administrator-type users who are trusted to perform specific administrative tasks.
### Scope of Application Concept
Each hierarchical element establishes a **scope of application**, a fundamental concept in infrastructure design. This scope determines the set of machines on which specific tasks can be executed, providing granular and organized control of management operations.
!!! tip "Infrastructure Design"
The scope of application is key to efficiently planning the management of machines in your organization.
## Decentralized Administration
The OpenGnsys administration tool allows a single administrator to centrally manage resources. In addition to this centralized administration, a decentralized administration can be defined that leverages the new simplified hierarchical structure.
### Delegating Authority over an Organizational Unit
The console administrator or superadministrator can manage the delegation of administrative responsibilities for specific organizational units to other administrators.
With the new simplified structure, this delegation can be made over any type of group, providing greater flexibility in distributing administrative responsibilities.
These administrators will manage their organizational unit through the console's web interface, having full control over the elements contained within their scope of responsibility.
### Delegating Tasks to Users with or without Authority
An organizational unit administrator can delegate specific tasks within the scopes that belong to their organizational unit, regardless of the type of group they manage.
These delegated tasks are accessible by the user from the managed computer's own terminal. The delegated tasks are included in a menu that may require authentication a private menu or not a public menu.
A **public menu** typically includes the task of starting a specific operating system. On the other hand, a **private menu** which requires authentication is intended to offer cloning options on the computer itself or on all computers in a specific group.
The flexibility of the new structure allows these delegations to adapt to various organizational scenarios, from traditional structures to geographically distributed groups.
## The Predefined OpenGnsys Schema
During the installation process of OpenGnsys, the schema is automatically configured, offering a basic structure adapted to the new simplified hierarchy. This default configuration implements the four conceptual types of Organizational Units to facilitate organizational management.
### Default Structure
The predefined schema establishes the following organizational hierarchy:
- **Center**: Represents the main organizational level
- **Classroom Group**: Allows grouping of multiple classrooms with similar characteristics
- **Classroom**: Defines specific physical spaces with computers
- **Client Group**: Facilitates the grouping of specific workstations
This default structure can be fully adapted to the specific needs of each organization, allowing nested groups at multiple levels according to particular requirements.
### Initial Administrative Configuration
Access to console administration is initially allowed for a single superadministrator user, who also has administrative rights over all organizational units by default. The name and password for this user are set during the installation process.
Delegated administration of organizational units is initially undefined, except for the OpenGnsys image repository service, which by default is the machine where the application is installed.
### Organizational Flexibility
Although this default structure is based on the traditional educational model (Center→Classroom Group→Classroom→Client Group), the new architecture allows surpassing this scheme, facilitating more complex or different organizations based on the specific needs of each environment.
This flexibility allows isolated workstations in different locations to be efficiently grouped or for completely different organizational structures from the traditional educational model to be implemented.
## Group Administration
To manage groups, access the **Groups** module from the left side menu, where the following screen will be displayed:
- Filter and Search Menu
- Group Tree (Organizational Unit/Classroom)
- Clients (corresponding to the selected group in the left panel)
![oggui-grupos.png](/assets/images/screenshots/oggui-grupos.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
## Group Features
Groups allow configuration inheritance, meaning settings applied to a higher-level group are automatically inherited by lower-level groups unless specified otherwise. This includes:
- Network and DHCP service
- Boot Server Configuration
- ogLive version
- PXE template
- NTP Server
- Image Repository
- P2P Configuration (mode, time)
- Multicast Configuration (speed, port, mode)
- Boot Menu
- Hardware Profile
### Creating Groups
To create a new group:
1. Go to the **Groups** menu
2. Select "New Organizational Unit"
3. Define the type of group (Center, Classroom Group, Classroom, Client Group)
4. Fill in the required information
5. Save the changes
![oggui-grupos_crear.png](/assets/images/screenshots/oggui-grupos_crear.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
### Creating Clients
To register clients, there are two options:
- Register a single client
- Bulk client registration
To register a client:
1. Go to the **Groups** menu
2. New Client -> Add Single Client
3. Fill in the client information
![oggui-grupos_crear-cliente.png](/assets/images/screenshots/oggui-grupos_crear-cliente.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
For bulk client registration:
- A text file must be created (it can be `.txt` or any plain text format) with the following DHCP configuration structure:

View File

@ -80,7 +80,7 @@ Para administrar los grupos, accedemos al módulo **Grupos** del menú lateral i
- Arbol de Grupos (Unidad Organizativa/Aula)
- Clientes (correspondientes al grupo seleccionado en el panel de la izquierda)
![oggui-grupos.png](../assets/images/screenshots/oggui-grupos.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
![oggui-grupos.png](/assets/images/screenshots/oggui-grupos.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
## Características de los Grupos
@ -107,7 +107,7 @@ Para crear un nuevo grupo:
4. Completa la información requerida
5. Guarda los cambios
![oggui-grupos_crear.png](../assets/images/screenshots/oggui-grupos_crear.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
![oggui-grupos_crear.png](/assets/images/screenshots/oggui-grupos_crear.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
### Creación de Clientes
@ -122,7 +122,7 @@ Para dar de alta un cliente:
2. Nuevo Cliente -> Añadir cliente unitario
3. Cubrir la información del cliente
![oggui-grupos_crear-cliente.png](../assets/images/screenshots/oggui-grupos_crear-cliente.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
![oggui-grupos_crear-cliente.png](/assets/images/screenshots/oggui-grupos_crear-cliente.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
Para dar de alta varios clientes de forma masiva
@ -144,4 +144,4 @@ host nombre_host02 {
- **Subir fichero**: Se carga el fichero con el formato correspondiente
- **Pegar contenido**: Se pega directamente el contenido en la ventana de importación
![oggui-grupos_crear-clienteS.png](../assets/images/screenshots/oggui-grupos_crear-clienteS.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }
![oggui-grupos_crear-clienteS.png](/assets/images/screenshots/oggui-grupos_crear-clienteS.png){ style="display: block; margin: 20px auto; max-width: min(1024px, 100%); height: auto;" }

View File

@ -1,5 +1,6 @@
site_name: OpenGnsys v3.0
site_url: https://opengsys.es
use_directory_urls: true
repo_url: https://dev.opengnsys.es/gitea
repo_name: OpenGnsys Gitea
@ -150,7 +151,6 @@ plugins:
draggable: true
skip_classes:
- custom-skip-class-name
auto_themed: false
auto_caption: false
caption_position: bottom
background: white
@ -186,8 +186,7 @@ plugins:
minify_html: true
minify_js: true
minify_css: true
- tags: # Añadido: soporte para etiquetas
tags_file: tags.md # Archivo donde se muestran todas las etiquetas
- tags # Añadido: soporte para etiquetas
- social # Añadido: imágenes para compartir en redes
- pdf-generate:
author: "OpenGnsys"