Descargar smrs - Descarga del código fuente smrs

smrs

Otras categorias

1.0.0

Descargar

SMRS

Este repositorio contiene el código fuente para un acortador de enlace descartado con CGI escrito en óxido. Puede alojar este proyecto en su propio entorno utilizando las instrucciones a continuación.

Por qué SMRS

Los enlaces en la web se están hinchando cada vez más. ¡Los amigos no envían amigos de múltiples líneas! Sin embargo, los servicios de enlaces de terceros son una pesadilla de privacidad. Pero principalmente, quería aprender óxido y esto parecía un proyecto simple.

Características

Este proyecto está destinado a ser mínimo y simple. Características del usuario:

UI mínima y receptiva
API simple (ver más abajo)
Genera URL cortas de tres palabras
Le permite elegir opcionalmente su URL corta

Características del software:

Permitimos que un servidor web real (APOCHE2) maneje la terminación de TLS y el servicio de archivo estático.
Ejecutamos el binario de óxido a través de CGI para implementar la API e interactuar con SQLite.
El front-end utiliza el SSIS de Apache para representar páginas estáticas con un encabezado común.
Usamos un poco de alpine.js para elementos interactivos.
No hay inicio de sesión, pero puede ver y establecer su propia cookie de sesión para realizar un seguimiento de sus enlaces acortados.

Captura de pantalla

Instalación

La forma recomendada de instalar este proyecto es usar la imagen Docker. Sin embargo, especialmente si solo desea usar la API, también puede instalar el binario directamente en su propio servidor web.

Via Docker

Primero, prepare un directorio para el archivo de datos. Debe ser propiedad del usuario con UID 82 (Data www en Debian/Ubuntu).

$ mkdir -p ${STORAGE} /smrs/data
$ sudo chown 82:82 ${STORAGE} /smrs/data

Aquí hay un ejemplo de estrofa Docker-Compose:

  smrs :
    image : ghcr.io/igor47/smrs:v0.1.1
    restart : unless-stopped
    container_name : smrs
    labels :
      - " traefik.enable=true "
      - " traefik.http.routers.smrs.rule=Host(`example.com`,`www.example.com`) "
      - " traefik.http.routers.smrs.tls=true "
      - " traefik.http.routers.smrs.tls.certresolver=letsencrypt "
      - " traefik.http.routers.smrs.entrypoints=https "
      - " traefik.http.services.smrs.loadbalancer.server.port=8000 "
    volumes :
      - ${STORAGE}/smrs/data:/smrs/data

Esto utiliza Traefik como un proxy inverso al puerto de contenedor 8000. Puede usar su propio proxy inverso o exponer el puerto directamente.

Vía binario

Clonar el repositorio y construir el binario:

$ cargo build --release

Coloque el archivo target/release/smrs en algún lugar de la ruta de su servidor web. Deberá configurar su servidor para ejecutar el binario como un script CGI. Utilizo apache2 dentro del contenedor. El archivo de configuración está en conf/smrs.conf en este repositorio.

API

El binario de óxido implementa los siguientes puntos finales de la API:

GET /session - Devuelve la sesión actual como { session: string }
POST /session - Establece la cookie de sesión en el valor dado { session: string }
POST /save - Guarda la URL en el token dado (si aún no está en uso) { url: string, token: string }
GET /to/<token - redirige a la URL en el token dado, o devuelve un 404
GET /list : devuelve una lista de todos los tokens y URL guardados por la session actual como { links: [{ token: string, url: string, created_at: i32 }]
POST /forget : marca el token dado como se elimina, o 404 : { token: string }

Desarrollo

Para ejecutar este proyecto localmente, puede instalar la herramienta cargo make y ejecutar la tarea devenv :

$ cargo make devenv

Se puede acceder al entorno de desarrollo en Localhost: 8000/. Esto atacará a los htdocs dir en el contenedor para que pueda iterar en el código y recargar. Para iterar en el binario de óxido, puede ejecutar la tarea iter , que construirá el binario localmente y copiará en el contenedor:

$ cargo make iter

Solicitud de solicitud

¡Bienvenido! Pero tenga en cuenta que este proyecto está destinado a ser mínimo. No aceptaré PRS que agregan demasiadas dependencias o características que no quiero.