Налаштування інструментів розробки

​

Рекомендовані інструменти розробки

Ці необов’язкові сервіси не потрібні для запуску Overleaf, але настійно рекомендуються для розробки, налагодження та перевірки під час локальної розробки.

• Hoppscotch — легкий інструмент для тестування API, подібний до Postman, але браузерний і дуже зручний для розробки.
  • Фронтенд: http://localhost:3000
  • Проксі (для обходу CORS): http://localhost:9159
• RedisInsight надає візуальний інтерфейс для перегляду даних Redis. Інтерфейс доступний за адресою: http://localhost:5540
• Mongo Express — вебінтерфейс для MongoDB. Відкрийте http://localhost:8081 з обліковими даними: admin:pass

Додайте наступне до вашого 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

​

Налаштування Hoppscotch

​

Проксіювання API-запитів

Щоб налаштувати Hoppscotch, відкрийте http://localhost:3000 і перейдіть на вкладку налаштувань. Встановіть для Proxy значення http://localhost:9159, щоб ваші інструменти налагодження могли взаємодіяти з внутрішніми мережами контейнерів.

Тепер можна перевірити http://web:3000/status, щоб переконатися, що web працює:

​

Проблеми з CSRF

Якщо ви використовуєте Postman або інші інструменти налагодження для створення POST-запиту, ви можете виявити, що вхід заборонено, а причиною є помилка 401. Це тому, що Overleaf захищений перевіркою CSRF.

У консолі ви можете побачити:

Щоб розв’язати це під час розробки Overleaf, потрібно налаштувати CSRF-токен. Нижче наведено докладну інструкцію.

1. Додайте Pre-Request

   Додайте такий код до Pre-Request

   

   Скрипт виглядає так:

   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. Додайте заголовки запиту

   Потрібно додати такі заголовки:

   Назва заголовка	Значення заголовка
   Content-Type	application/json
   X-Csrf-Token	<<csrftoken>>
   Cookie	<<cookie_header>>

   
3. Увійдіть за допомогою API-інструментів

   Тепер можна увійти, використовуючи ім’я користувача та пароль.

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

   Ось відповідь у разі введення неправильного імені користувача або пароля.