grandes avances previos al primer deployment en reevo.wiki

1 files changed, 68 insertions, 0 deletions

diff --git a/README.md b/README.md
index 701a1657..53df2474 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,71 @@
 # REEVO 2020
 
 Repositorio de código de la plataforma unificada de REEVO, correspondiente al periodo 2019-2020
+
+## Componentes
+
+* Mediawiki 1.30.1
+* SemanticMediawiki 3.0.0
+
+## Instalación
+
+Para generar las tablas en la base de datos hacemos (no usamos el ```LocalSettings.php``` resultante):
+
+```php www/wiki/maintenance/install.php --dbname=<dbname> --dbserver="localhost" --installdbuser=<dbuser> --installdbpass=<dbuserpass> --dbuser=<dbuser> --dbpass=<dbuserpass> --server="http://reevo.test" --scriptpath=/ --lang=es --pass=<adminpass> "REEVO TEST" "Admin" --confpath /var/dump```
+
+Cargamos los datos para conectar con la base de datos en ```etc/global_config.php```.
+
+Activamos el ```LocalSettings.php``` oficial: ```ln -s www/wiki/LocalSettings.Reevo.php www/wiki/LocalSettings.php```
+
+Corremos el script para generar tablas y cambios de las extensiones: ```php www/wiki/maintenance/update.php```
+
+## Documentación de herramientas propias
+
+### Cargar páginas, propiedades y formularios
+
+* Script: ```bin/wiki/initReevo.php```
+* Descripción: se usa para crear o actualizar las páginas con propiedades, plantillas, formularios que se alojamos en ```bin/wiki/reevoPages```. Luego de crear o actualizar, se protegen para que solo los admins puedan editarlas.
+
+Para crear todas las páginas:
+
+```cd bin/wiki/ && php initReevo.php --int```
+
+Para actualizar todas las páginas cuando ya están creadas:
+
+```cd bin/wiki/ && php initReevo.php --int --force```
+
+Para actualizar solo las que pertenecen a un namespace:
+
+```cd bin/wiki/ && php initReevo.php --int --force Propiedad```
+
+Para actualizar una página en particular:
+
+```cd bin/wiki/ && php initReevo.php --int --force Propiedad:Prensa:url```
+
+
+### Generador de archivos de prensa
+
+* Script: ```bin/wiki/GeneraSnapshot.php```
+* Descripción: se usa para generar una copia en texto e imagen (snapshot) de los Objetos de Prensa (antes "Recursos Externos" o "Enlaces")
+
+
+### Creador de páginas de usuarios que importa datos de Elgg
+
+* Script: ```bin/wiki/ImportarPerfil.php```
+* Extensión de MW: ```ImportarPerfil```
+* Descripción: cuando un usuario nuevo en el wiki usa un e-mail que tiene asociado un usuario en Elgg, se crea la página Usuario:NombreDeUsuario tomando los valores del perfil de Elgg. Si lo que coincide es el nombre de usuario nuevo y uno antiguo en Elgg, se pregunta al usuario se quiere hacer la importación (ya que podria ser otra persona queriendo usar el mismo nombre de usuario).
+
+Se usa el elgg-cli para exportar los datos:
+
+```/srv/reevo-web/www/red/vendor/hypejunction/elgg-cli/elgg-cli user:get --username=Yaco```
+
+Para que el usuario API funcione, tiene que tener el email validado, para hacerlo por consola:
+
+```
+php resetUserEmail.php User user@gmail.com
+php changePassword.php --user=User --password=password
+```
+
+No anda el script de extraccion de ELGG si esta activado el plugin ```profile_manager_joingroups```
+
+Se puede importar desde la línea de comandos cualquier usuario de ELGG con este comando: ```php bin/wiki/ImportarPerfil.php -f true -u <Usuario>```