gemlikes

gemlikes

¡Un sistema de gusto y comentarios para el Protocolo Géminis, especialmente para Gemlogs! Funciona usando CGI, por lo que no hay un servidor adicional para ejecutar.

Estado del proyecto

Este es principalmente un proyecto de juguete/demostración. Funciona, y lo ejecuto en mi gemlog, pero rápidamente fue hecho y no bien diseñado. Por esta razón, este repositorio ahora está archivado. Vea mi publicación de blog para obtener más detalles.

¡Tal vez mira a Nimike en su lugar!

Ejemplo

Visite gemini://makeworld.space/gemlog/2020-05-21-first.gmi (proxy) para ver una demostración de ella en acción. Aquí hay una salida de ejemplo:

 # 2020-05-21-first.gmi

15 likes! 
=> like?2020-05-21-first.gmi Add yours

4 comments 
=> add-comment?2020-05-21-first.gmi Add yours

ben (id: 7ec5a44d) @ Sun, 24 May 2020 04:49:11 UTC:
hello there!

makeworld (id: 4f9da128) @ Sun, 24 May 2020 04:45:06 UTC:
Test 3

makeworld (id: 4f9da128) @ Sun, 24 May 2020 04:32:26 UTC:
Test number 2

makeworld (id: 4f9da128) @ Sun, 24 May 2020 04:23:53 UTC:
Test comment.

Los comentarios se muestran con lo último en la parte superior.

Instalación

Hubo un error en el servidor Molly Brown Gemini que hizo que Gemlikes no funcionara. Actualice su Molly Brown para Commit 2e4a10297e o más tarde, si lo está utilizando. Otros servidores deberían estar bien.

Hay tres binarios para instalar: view , like y add-comment .

• Los nombres binarios no deben cambiarse
• Deben colocarse en un directorio que permita que su servidor ejecute los binarios
  • se recomienda cgi-bin/gemlikes/
• Todos deben estar en el mismo directorio, de modo que funcione los enlaces relativos

También hay un archivo de configuración que debe estar en el mismo directorio, con el nombre gemlikes.toml . Este nombre no se puede cambiar. Mire el archivo de ejemplo-config.toml en el repositorio para ver las opciones disponibles. Deberá crear y cambiar el archivo de configuración, no funcionará sin uno.

Finalmente, cree un archivo robots.txt en la raíz del sitio y no permita los bots para acceder a los binarios like y add-comment , para evitar que los rastreadores accidentales sean accidentales. Aquí hay un archivo de ejemplo, si los binarios están instalados en /cgi-bin/gemlikes/ :

 User-agent: *
Disallow: /cgi-bin/gemlikes/like
Disallow: /cgi-bin/gemlikes/add-comment 

Obtener binarios

La opción más fácil es descargar el archivo .tar.gz apropiado de la página de versiones, extraerlo ( tar xvfz filename ) y mover los tres binarios al directorio correcto como se describe anteriormente.

Si tiene instalado la cadena single-build.sh herramientas GO, también puede clonar el repositorio (no go get Los binarios estarán en la carpeta build recién hecha, listas para ser movidas.

Uso

1. Encuentre un archivo que desee que los usuarios puedan gustar (y comentar)
2. Asegúrese de que el archivo esté en un directorio especificado en su archivo gemlikes.toml
3. Agregue un enlace a hostname.tld/path/to/gemlikes/view?file-name.gmi

Por ejemplo, si el archivo está en gemini://example.com/gemlog/first-post.gmi , y mis binarios están en gemini://example.com/cgi-bin/gemlikes/ , así es como debe verse el archivo:

 <blog post text here, blah blah>

=> gemini://example.com/cgi-bin/gemlikes/view?first-post.gmi View likes and comments!

Medidas protectoras

Gemlikes tiene algunas protecciones para prevenir el abuso o la suplantación del sistema de comentarios y gustos. Tenga en cuenta que un administrador de servidor puede hacer comentarios y me gusta decir lo que quiera.

• Se genera una identificación en función de la dirección IP del comentarista para evitar la suplantación de otros comentaristas
  • Se muestra justo al lado de su nombre de usuario, como se puede ver arriba
• Los nombres de usuario no se pueden reutilizar en una sola página por diferentes direcciones IP
• Una dirección IP no puede hacer más de 5 comentarios en una página de forma predeterminada, aunque esto es configurable en el archivo gemlikes.toml
• La misma dirección IP no puede gustarle un archivo más de una vez
• Solo los archivos en los directorios especificados en gemlikes.toml pueden ser y comentados: tratar de hacer referencia a los archivos que no existen dará un error

Limitaciones

• No puede manejar múltiples archivos del mismo nombre en diferentes ubicaciones. Por ejemplo, si hay un archivo en /myfile.gmi y otro archivo en /dir/myfile.gmi , Gemlikes se negará a mostrar o realizar acciones, porque no sabe a cuál se hace referencia.
  • Esto solo se aplica si ambos directorios en los que se encuentran estos archivos se incluyen en el archivo gemlikes.toml . Si solo se especifica uno, como /dir , no habrá ningún problema.
• Los comentarios no se pueden deshabilitar por archivo, solo a nivel mundial. Puedo agregar esto en el futuro.

Licencia

Gemlikes tiene licencia bajo la Licencia Pública General de GNU Affero, versión 3. El punto principal de esta licencia es que incluso si modifica el código y no distribuye el software a nadie, aún tendrá que liberar sus cambios si usa este código en un servidor público. Consulte el archivo de licencia para obtener más detalles.