Nastavení vývojových nástrojů

​

Doporučené vývojové nástroje

Tyto volitelné služby nejsou ke spuštění Overleafu potřeba, ale pro vývoj, ladění a kontrolu během lokálního vývoje je důrazně doporučujeme.

• Hoppscotch je odlehčený nástroj pro testování API podobný Postmanu, který ale běží v prohlížeči a je pro vývoj velmi pohodlný.
  • Frontend: http://localhost:3000
  • Proxy (pro obejití CORS): http://localhost:9159
• RedisInsight poskytuje vizuální rozhraní pro prohlížení dat v Redisu. Rozhraní je dostupné na: http://localhost:5540
• Mongo Express je webové rozhraní pro MongoDB. Můžete navštívit http://localhost:8081 s přihlašovacími údaji: admin:pass

Přidejte prosím do svého docker-compose.yml následující:

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

​

Nastavení Hoppscotch

​

Proxy pro požadavky API

Pro nastavení Hoppscotch navštivte http://localhost:3000 a přejděte na kartu nastavení. Musíte nastavit Proxy na http://localhost:9159, aby vaše ladicí nástroje mohly komunikovat s interními sítěmi kontejnerů.

Nyní můžete pomocí http://web:3000/status otestovat, zda služba web běží:

​

Problémy s CSRF

Pokud pomocí Postmanu nebo jiných ladicích nástrojů vytvoříte požadavek POST, můžete zjistit, že přihlášení je zakázáno a příčinou je chyba 401. Je to proto, že Overleaf je chráněn ověřováním CSRF.

V konzoli můžete vidět:

Abyste to při vývoji Overleafu vyřešili, musíte nastavit CSRF token. Zde je podrobný návod.

1. Přidání Pre-Request skriptu

   Přidejte následující kód do Pre-Request

   

   Skript je následující:

   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. Přidání hlaviček požadavku

   Musíte přidat následující hlavičky:

   Název hlavičky	Hodnota hlavičky
   Content-Type	application/json
   X-Csrf-Token	<<csrftoken>>
   Cookie	<<cookie_header>>

   
3. Přihlášení pomocí nástrojů API

   Nyní se můžete přihlásit pomocí svého uživatelského jména a hesla.

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

   Takto vypadá odpověď, když zadáte nesprávné uživatelské jméno nebo heslo.