Configurar herramientas de desarrollo

​

Herramientas de desarrollo recomendadas

Estos servicios opcionales no son necesarios para ejecutar Overleaf, pero son muy recomendables para desarrollar, depurar e inspeccionar durante el desarrollo local.

• Hoppscotch es una herramienta ligera de pruebas de API similar a Postman, pero basada en el navegador y muy práctica para el desarrollo.
  • Frontend: http://localhost:3000
  • Proxy (para evitar CORS): http://localhost:9159
• RedisInsight ofrece una interfaz visual para inspeccionar los datos de Redis. Interfaz disponible en: http://localhost:5540
• Mongo Express es una interfaz web para MongoDB. Puedes visitar http://localhost:8081 con las credenciales: admin:pass

Añade lo siguiente a tu docker-compose.yml:

develop/docker-compose.yml

develop/docker-compose.yml

# services: 
  # Overleaf Dev Containers
  # ...
  
  # Add those for your development
  # API debug
  hoppscotch-frontend:
    image: hoppscotch/hoppscotch-frontend:latest
    ports:
      - "3000:3000"

  hoppscotch-proxy:
    image: hoppscotch/proxyscotch:latest
    environment:
      - PORT=9159
    ports:
      - "9159:9159"

  # Redis-insight
  redis-insight:
    image: redislabs/redisinsight:latest
    ports:
      - "5540:5540"
    depends_on:
      - redis
    volumes:
      - ./data/redis-insight:/data

  # mongo-express
  # basicAuth credentials are "admin:pass"
  mongo-express:
    image: mongo-express
    ports:
      - "8081:8081"
    environment:
      ME_CONFIG_MONGODB_SERVER: mongo

​

Configurar Hoppscotch

​

Solicitudes de API a través del proxy

Para configurar Hoppscotch, visita http://localhost:3000 y ve a la pestaña de ajustes. Debes establecer Proxy en http://localhost:9159, para que tus herramientas de depuración puedan interactuar con las redes internas de los contenedores.

Ahora puedes probar con http://web:3000/status para comprobar si web está activo:

​

Problemas de CSRF

Si usas Postman u otras herramientas de depuración para generar una solicitud post, es posible que el inicio de sesión quede prohibido, con un error 401. Esto se debe a que Overleaf está protegido mediante verificación csrf.

En tu consola, puede que veas:

Para resolver esto en tu desarrollo de Overleaf, debes configurar tu token csrf. Este es el tutorial detallado.

1. Añadir Pre-Request

   Añade el siguiente código en Pre-Request

   

   El script es el siguiente:

   pm.sendRequest("http://web:3000/dev/csrf", function (err, res) {
       if (err) {
           console.log(err);
           return;
       }
   
       // 1) Save CSRF token (/dev/csrf)
       const token = res.text().trim();
       pw.env.set("csrftoken", token);
       console.log("csrftoken =", token);
   
       const setCookieHeader = (res.headers || []).find(h => h.key?.toLowerCase() === "set-cookie")?.value;
       console.log("set-cookie =", setCookieHeader);
   
       if (!setCookieHeader) return;
   
       const cookiePair = setCookieHeader.split(";")[0].trim(); // overleaf.sid=...
       pw.env.set("cookie_header", cookiePair);
       console.log("cookie_header =", cookiePair);
   });
   
2. Añadir cabeceras de la solicitud

   Debes añadir las siguientes cabeceras:

   Nombre de la cabecera	Valor de la cabecera
   Content-Type	application/json
   X-Csrf-Token	<<csrftoken>>
   Cookie	<<cookie_header>>

   
3. Iniciar sesión con herramientas de API

   Ahora puedes iniciar sesión con tu nombre de usuario y contraseña.

   {
     "_csrf": "<<csrftoken>>",
     "email": "[e-mail]",
     "password": "xxxxxx"
   }
   

   Esta es la respuesta cuando introduces un nombre de usuario o una contraseña incorrectos.