opengnsys
/
oggit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve installer documentation

fixes
Vadim vtroshchinskiy 2024-11-06 14:20:36 +01:00
parent eaa46993a6
commit 4b4669e908
1 changed files with 4 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
installer/README.md
View File

@ -11,34 +11,6 @@ Para instalar dependencias de python se usa el modulo venv (https://docs.python.
sudo apt install python3-git python3-libarchive-c python3-termcolor bsdextrautils
## Distribuciones antiguas (< 24.04)
sudo apt install python3 python3-venv libarchive-dev
python3 -m venv venvog
. venvog/bin/activate
python3 -m pip install --upgrade pip
pip3 install -r requirements.txt
## Distribuciones muy antiguas (18.04, no soportado)
**Nota:** En 18.04, `uname` solo se encuentra en `/bin`, lo que causa un error inocuo en el log durante la creación de los repositorios:
Failed checking if running in CYGWIN due to: FileNotFoundError(2, 'No such file or directory')
Se arregla con el symlink incluido en las instrucciones mas abajo.
sudo apt install -y python3.8 python3.8-venv python3-venv libarchive-dev
sudo ln -sf /bin/uname /usr/bin/
python3.8 -m venv venvog
. venvog/bin/activate
python3.8 -m pip install --upgrade pip
pip3 install -r requirements.txt
Ejecutar con:
python3.8 ./opengnsys_git_installer.py
## Agregar clave de SSH si es necesario
@ -50,21 +22,21 @@ para agregarla.
# Ejecutar
**Nota:** Preferiblemente ejecutar como `root`, ya que `sudo` borra los cambios a las variables de entorno realizadas por venv. El resultado probable es un error de falta de módulos de Python, o un fallo del programa por usar dependencias demasiado antiguas.
# . venv/bin/activate
# ./opengnsys_git_installer.py
Debe ejecutarse como `root`.
El instalador descarga e instala Forgejo, un interfaz web de Git. La configuración se genera automáticamente.
Forgejo gestiona los repositorios y el acceso por SSH, por lo cual debe quedarse siempre corriendo. Por defecto se instala en el puerto 3000.
El usuario por defecto es `opengnsys` con password `opengnsys`.
El usuario por defecto es `oggit` con password `opengnsys`.
# Documentación
# Documentación de código fuente
Se puede generar documentación de Python con una utilidad como pdoc3 (hay multiples alternativas posibles):