CPIF

Manual de uso de la versión 1.0 (documentación en desarrollo 20071114)

Jesús Cea Avión

David Menéndez Hurtado

Este manual describe las características y funcionamiento de la versión 1.0 de CPIF.

Siguiendo las normas de desarrollo del proyecto, las versiones 1.0.* suponen corrección de bugs que no alteran las funcionalidades ni la apariencia básica del programa, por lo que este manual conserva su validez.


Table of Contents
1. Usuario
1.1. Acceso
1.2. Navegación
1.3. Publicación de mensajes
1.4. Monitorización
1.5. Privados
1.6. Subforos de grupos
2. Moderador
3. Administrador
3.1. Configuración de una instalación CPIF
3.2. Grupos de usuarios
3.3. Subforos
3.4. Categorías
4. Migración de phpBB a CPIF
5. Creación de "skins"
6. Creación de "plugins"

Chapter 1. Usuario

1.1. Acceso

Nada más entrar, vemos un listado de los subforos visibles a los invitados y un cajetín en la parte inferior. La única opción viable de estas para un usuario anónimo es hacer LOGIN. De esta forma, se abrirá una nueva página en la que podremos escoger entre introducir usuario y contraseña o mediante OpenID. La cookie tiene una caducidad de años, por lo que se nos recordará permanentemente.

Una vez dentro, seremos redireccionados a la página principal. Podemos notar ciertas diferencias con respecto a la anterior vez: aparece un nuevo subforo (privado) y las opciones de "monitorizar" junto a cada uno de ellos.


1.2. Navegación

Para la mayoría de subforos, no es imprescindible haberse autentificado antes, pero supone una ventaja importante: te marca los mensajes no leídos. En la página principal se ve, junto al nombre de cada subforo, el texto "NO LEÍDO" cuando haya mensajes nuevos. Pulsando sobre el nombre podremos acceder.

Una vez dentro, veremos los hilos organizados por la fecha del último mensaje escrito. Pare entrar en ellos, sólo hay que hacer click en su nombre.

Algunos de ellos, tendrán, delante de todo, un pequeño icono naranja con una flecha negra. Eso nos indica que se han publicado más mensajes desde la última vez que lo visitamos. Para ir a verlos directamente, saltándonos los que ya hemos léido, pulsaremos en él.

Una vez dentro del hilo, se nos mostrarán los mensajes puestos. Junto a ellos, podrá verse el nombre del autor y su avatar. Si nos hemos autentificado, podremos ver, además, los botones de "responder".


1.3. Publicación de mensajes

Para ello es imperativo ser usuario registrado. Pueden ser respuestas dentro de un hilo, o apertura de hilos nuevos.

En el primer caso, tenemos dos opciones. O bien avmos al final del mismo y pulsamos el enlace homónimo, que abre un cajetín en la misma página, o bien pulsamos en el que se encuentra debajo de cada mensaje. Ambos son, a efectos prácticos, equivalentes, pero el segundo caso incluye una cita al mensaje en cuestión.

No se puede responder a un hilo "de solo lectura" (cerrado).

Para abrir hilos nuevos, hemos de hacerlo desde el listado dentro de un subforo. Al igual que en los mensajes dentro de un hilo, hay un enlace llamado "Iniciar un nuevo hilo" que abre un doble cajetín. En el hueco superior, habremos de escribir el título del hilo. En el inferior, el texto. Ambos campos son obligatorios.

Se permite algo de XHTML y BBCode.


1.4. Monitorización

La monitorización es un seguimiento de la actividad del foro. Podemos monitorizar tanto un hilo (en el que se nos avisará si hay mensajes nuevos) o todo un subforo (en cuyo caso, se notificará la presencia de nuevos hilos).

Para monitorizar, es necesario haberse autentificado y haber dado una dirección de correo válida.

Asegúrate de que el filtro de spam deja pasar las notificaciones.


1.5. Privados

Los privados son...


1.6. Subforos de grupos

Se trata de una categoría especial de subforo, sólo visible a los miembros de un grupo. Si perteneces a uno de ellos, se comportará para tí como un subforo normal.


Chapter 2. Moderador

Un moderador es un usuario normal al que el administrador ha concedido privilegios de moderación en un subforo determinado. Dichos privilegios consisten en:


Chapter 3. Administrador

El administrador es un usuario con las siguientes características adicionales:


3.1. Configuración de una instalación CPIF

Las instalaciones CPIF se configuran a través de la interfaz web. Las opciones disponibles son:

Number of messages per page on a thread

Indica el número de mensajes que se muestran en cada página de un hilo. Se recomienda no alterar este valor una vez que el foro entra en producción, ya que si se modifica, los enlaces externos que pueda haber a mensajes del hilo podrían fallar.

Allow anonymous access?

Si esta opción no está activada, cualquier acceso al foro requerirá que el usuario se autentifique previamente. Una vez autentificado, el foro le permitirá la entrada a la URL que el usuario indicó al principio.

Allow private messaging between users?

Si esta opción no está activada, no se permite que los usuarios se envíen mensajes privados entre ellos. Los mensajes privados que ya se hayan cursado, siguen disponibles.

Simultaneous HTTP connections

Indica el número de conexiones web (considerémoslos como usuarios) que se permiten simultaneamente. Si llegan unas pocas más conexiones de las indicadas, se encolarán. Si llegan muchas más, se empezarán a rechazar conexiones con un error.

Si los usuarios se conectan a CPIF a través de un sistema intermedio, como Apache o SQUID, tal y como se recomienda, aconsejamos que este valor no se modifique.

Specify initial HTTP timeout

Indica el número de segundos que CPIF esperará, cuando recibe una conexión nueva, para que ésta le transmita su petición web. Este valor permite reducir el impacto de ataques web.

Si los usuarios se conectan a CPIF a través de un sistema intermedio, como Apache o SQUID, tal y como se recomienda, aconsejamos que este valor no se modifique.

Keep-alive timeout

Poniendo un valor superior a cero en este campo, permitimos que los navegadores web de los usuarios se beneficien de la tecnología "keep-alive" HTTP, ganando velocidad de navegación. No obstante esta funcionalidad puede utilizarse también como mecanismo de ataque, de ahí que CPIF permita limitar el tiempo de espera "keep-alive".

Si los usuarios se conectan a CPIF a través de un sistema intermedio, como Apache o SQUID, tal y como se recomienda, aconsejamos que este valor no se modifique.

New Users Sign In

A través de esta opción el administrador puede configurar el mecanismo por medio del cual se crean usuarios nuevos. Las opciones posibles son:

  • Solo el administrador puede crear usuarios nuevos.

  • Los usuarios pueden iniciar un proceso de registro, pero se requiere la aprobación del administrador para que el registro sea efectivo.

  • Los usuarios pueden crear nuevos registros de forma libre y directa.

En los dos últimos casos, el registro no existe hasta que el usuario recibe un mensaje por correo electrónico y sigue sus instrucciones.

OpenID Support

Si se activa esta opción, el foro permitirá autentificación mediante el protocolo OpenID.

Se recomienda encarecidamente aceptar OpenID, aunque para ello CPIF requiere de librerías adicionales, tal y como se detalla en la sección de instalación.

Allow BBcode?

Esta opción permite el uso de etiquetas BBcode en los mensajes. Si no se aceptan, las etiquetas BBcode serán consideradas como texto normal.

Cambiar el valor de esta opción no afecta a los mensajes ya existentes.

Allow HTML?

Esta opción permite el uso de etiquetas HTML en los mensajes. Si no se aceptan, las etiquetas HTML serán consideradas como texto normal.

Cambiar el valor de esta opción no afecta a los mensajes ya existentes.

Allow avatar change

Si activamos esta opción, permitimos que los usuarios cambien su avatar. Por tanto, si esta opción está desactivada, los usuarios nuevos no podrán ponerse ningún avatar, lo que puede resultar conveniente.

Activar esta opción requiere instalar librerías de gestión gráfica, tal y como se detalla en la sección de instalación.

Cambiar el valor de esta opción no afecta a los avatares ya existentes en el sistema.

Base URL for this service

Aquí debe indicarse la URL "canónica" del foro. Es decir, la URL a través de la cual deberían acceder a los usuarios. Que este campo contenga un valor correcto es crítico, incluso aunque el foro solo esté disponible a través de una única URL.

En la URL no debe indicarse la barra (slash) "/" final.

TimeZone

Aquí se indica el "timezone" por defecto de CPIF. Es la zona horaria utilizada para los usuarios anónimos y para los usuarios que se creen nuevos.

Cambiar este valor no afecta a los usuarios ya existentes, incluso aunque éstos no hayan modificado la zona horaria con la que fueron creados.

Google's webmaster tools Verification code

Si el administrador CPIF utiliza las "Google's webmaster tools", aquí se pone el código de validación proporcionado por Google.

Google comprueba este código para reconocer al administrador de un sitio web, y proporcionarle estadísticas, perfiles de búsqueda, informes de errores e incidencias, "sitemap", etc.

Outgoing SMTP server

Aquí debe ponerse la dirección IP o, preferiblemente, el nombre del servidor al que CPIF debe conectarse para enviar correo.

CPIF enviará mensajes por correo electrónico al ser reiniciado, al registrar usuarios nuevos, como notificación de cambios en hilos y subforos, etc.

Outgoing SMTP server port

El puerto TCP donde el servidor de correo espera las conexiones entrantes. Por defecto se trata del puerto 25.

SMTP sender address

La dirección de correo del remitente de los mensajes salientes. Esta dirección debe existir, y el administrador debería revisarla con frecuencia, para detectar cualquier tipo de problema con la mayor premura.

Use TLS for SMTP

Marcamos esta opción si el servidor de correo saliente requiere cifrado. Por ejemplo, "gmail".

Outgoing SMTP user

Si el servidor de correo saliente requiere autentificación, aquí indicaremos el nombre de usuario a utilizar para ella.

Outgoing SMTP password

Si el servidor de correo saliente requiere autentificación, aquí indicaremos la clave a utilizar para ella.

CPIF Admin email address

Este campo especifica la dirección de correo del administrador CPIF. Esta dirección se utiliza para notificarle cualquier tipo de problema, para comunicarle el alta de usuarios nuevos que debe procesar, etc.

Naturalmente, el administrador revisar esta cuenta con frecuencia.


3.2. Grupos de usuarios

Un grupo de usuarios es un conjunto de usuarios que comparten unos permisos comunes y un subforo de uso privado.

El administrador CPIF puede crear grupos de usuarios, cambiarles el nombre, y asignar a cada grupo un número arbitrario de usuarios (incluyendo dejarlo vacío). Los usuarios que forman parte de un grupo se separan con comas.

Un mismo usuario puede pertenecer a un número arbitrario de grupos.


3.3. Subforos

Un foro CPIF está formado por subforos. El administrador puede cambiarles sus nombres y crear subforos nuevos. Un administrador también puede cambiar el orden en que se muestran los foros públicos en la página de entrada, asignarlos a categorías, etc.

Un subforo puede, opcionalmente, tener moderadores. Los moderadores pueden ser tanto usuarios como grupos de usuarios. Si se indican varios valores, se separan con comas.

El administrador CPIF es siempre un moderador implícito de los subforos.


Chapter 4. Migración de phpBB a CPIF

Queremos que la versión 1.0 final incluya una herramienta de migración phpBB a CPIF.

Puedes ayudarnos proporcionándonos acceso a la base de datos de una instalación phpBB.


Chapter 5. Creación de "skins"

El protocolo de "skins" de la versión 1.0 de CPIF no es público. No deberían diseñarse nuevos "skins" basados en el skin actual a menos que se esté dispuesto a tirar ese trabajo a la basura cuando se actualice la instalación CPIF.

El motivo de esta restricción es que el sistema de "skin" actual ha ido creciendo de forma "orgánica" a medida que las necesidades de CPIF se han ampliado, y no es una buena base para definir una arquitectura de "skin" consistente y fácil de usar.

Dicho esto, es voluntad del equipo de desarrollo de CPIF dotar al programa de un sistema de "skin" público potente y fácil de usar en la futura versión 1.1.


Chapter 6. Creación de "plugins"

La versión 1.0 de CPIF no dispone de capacidad "plugin". Todos los APIs internos deben considerarse privados y no se garantiza su estabilidad en futuras versiones de CPIF.

Somos conscientes de que ésta es una carencia importante, y pondremos los medios para resolverla en futuras versiones de CPIF.