Synchronizacja z Dropbox

Pozwól użytkownikom synchronizować projekty z folderem w ich Dropbox.

Ta funkcja została opracowana przez ayaka-notes/ayakaleaf-pro. Została wprowadzona w wersji v6.3.1 jako wczesna wersja zapoznawcza i zostanie oficjalnie wydana w wersji v6.4.0, więc jej konfiguracja i działanie mogą się jeszcze zmienić. Jeśli napotkasz jakiekolwiek problemy, prosimy o opinię.

Synchronizacja z Dropbox utrzymuje projekty użytkownika w synchronizacji z jego Dropbox, tak jak w Overleaf Cloud: gdy użytkownik połączy swoje konto Dropbox, każdy z jego projektów pojawia się jako folder w Apps/<your Dropbox app>/, zmiany w Overleaf są wysyłane do Dropbox, a zmiany wprowadzone w Dropbox wracają do Overleaf.

​

Konfiguracja synchronizacji z Dropbox

Najpierw musisz włączyć git-bridge: bez niego ustawienia konta ukrywają sekcję synchronizacji projektów.

config/overleaf.rc

GIT_BRIDGE_ENABLED=true

Utwórz aplikację w Dropbox App Console, zalogowawszy się na konto Dropbox, które będzie właścicielem aplikacji:

1. Kliknij Create app, a następnie wypełnij stronę:
   • 1. Choose an API: wybierz Scoped access.
   • 2. Choose the type of access you need: wybierz App folder, a nie Full Dropbox. Overleaf synchronizuje tylko zawartość folderu aplikacji.
   • 3. Name your app: wpisz nazwę, np. Overleaf. Musi być unikalna w Dropbox. Projekty każdego użytkownika pojawiają się w jego Dropbox w Apps/<name of your app>/, a ta nazwa to DROPBOX_APP_NAME poniżej.
   • Kliknij Create app. Aplikacja otworzy się na karcie Settings.
2. Na karcie Permissions, w sekcji Files and folders, zaznacz files.metadata.write, files.content.write i files.content.read. account_info.read i files.metadata.read zostaną zaznaczone razem z nimi i nie można ich odznaczyć. Nie zaznaczaj innych uprawnień.
3. Kliknij Submit na pasku u dołu karty Permissions. Bez kliknięcia Submit uprawnienia nie zostaną zapisane, a Dropbox odmówi synchronizacji plików użytkownikom, którzy połączą swoje konto.

Dropbox App Console: uprawnienia do zaznaczenia, zapisane przyciskiem Submit

4. Na karcie Settings, w sekcji OAuth 2, wpisz ${OVERLEAF_SITE_URL}/user/dropbox/oauth/callback w polu Redirect URIs, a następnie kliknij Add. Samo wpisanie adresu URI nie wystarczy: zostaje on zapisany dopiero wtedy, gdy pojawi się na liście nad polem.

Dropbox App Console: wpisz adres URI przekierowania, a następnie kliknij Add

5. Na karcie Settings, w sekcji Webhooks, wpisz ${OVERLEAF_SITE_URL}/dropbox/webhook w polu Webhook URIs, a następnie również kliknij Add. Dropbox od razu wywołuje ten adres, aby go sprawdzić, więc Overleaf musi już działać z poniższymi ustawieniami i być osiągalny z internetu (zobacz Webhook). Po pomyślnym sprawdzeniu jego stan zmienia się na Enabled.

Skopiuj App key oraz App secret (kliknij Show) z karty Settings, a następnie dodaj poniższe ustawienia do plików ze zmiennymi środowiskowymi Overleaf. Webhook (krok 5) możesz dodać, gdy Overleaf będzie już działać z tymi ustawieniami.

config/variables.env

# used to encrypt the user's Dropbox refresh token.
# How to generate: `openssl rand -hex 32`
DROPBOX_TOKEN_CIPHER_PASSWORD=0123456789ABCDEFG # changed to yours

# Dropbox Sync Settings
DROPBOX_ENABLED=true
DROPBOX_APP_KEY=
DROPBOX_APP_SECRET=
# the name of your Dropbox app (step 1), which is the folder name in Apps/
DROPBOX_APP_NAME=Overleaf

# OAuth callback is: ${OVERLEAF_SITE_URL}/user/dropbox/oauth/callback
# Webhook is: ${OVERLEAF_SITE_URL}/dropbox/webhook
# (Optional) DROPBOX_SYNC_PROXY_URL=http://10.0.0.1:10808

• Przed skonfigurowaniem adresu URI przekierowania i webhooka upewnij się, że OVERLEAF_SITE_URL jest ustawiony poprawnie.
• Dropbox ustala uprawnienia tokenu w momencie, gdy użytkownik łączy swoje konto: zatwierdzenie uprawnień nie zmienia istniejących tokenów. Użytkownicy, którzy połączyli konto przed zatwierdzeniem uprawnień lub przed ich zmianą, muszą odłączyć i ponownie połączyć swoje konto Dropbox.
• Nowa aplikacja ma status Development. Jeśli pole Development users na karcie Settings pokazuje Only you, połączyć można tylko Twoje konto Dropbox: kliknij Enable additional users, aby pozwolić innym użytkownikom połączyć ich konta. Następnie wyświetlana jest liczba połączonych użytkowników, np. 1 / 500: aplikacja w statusie Development obsługuje maksymalnie 500 użytkowników. Aby obsłużyć więcej użytkowników, kliknij Apply for production, a Dropbox przejrzy aplikację.

Jeśli znajdujesz się w regionie z ograniczonym dostępem do sieci, może być konieczne skonfigurowanie proxy, aby uzyskać dostęp do Dropbox. Ustaw następującą zmienną środowiskową: DROPBOX_SYNC_PROXY_URL=http://10.0.0.1:10808. Musi to być standardowy serwer proxy przekazujący HTTP/HTTPS i nie może używać 127.0.0.1.

​

Utwórz indeksy bazy danych

Uruchom to raz, zanim użytkownicy połączą swoje konta Dropbox. Indeksy używane przez synchronizację z Dropbox nie są tworzone automatycznie, więc bez nich każde wyszukiwanie podczas synchronizacji skanuje całą kolekcję.

Użytkownicy Toolkit: uruchom bin/mongo. Użytkownicy Docker Compose: uruchom docker compose exec mongo mongosh sharelatex. Następnie wklej:

db.dropboxEntities.createIndex(
  { 'overleaf.userId': 1, 'dropbox.id': 1 },
  { name: 'overleaf.userId_1_dropbox.id_1', unique: true,
    partialFilterExpression: { 'dropbox.id': { $exists: true } } })
db.dropboxEntities.createIndex(
  { 'overleaf.userId': 1, 'overleaf.id': 1 },
  { name: 'overleaf.userId_1_overleaf.id_1', unique: true,
    partialFilterExpression: { 'overleaf.id': { $exists: true } } })
db.dropboxEntities.createIndex({ 'overleaf.userId': 1, 'dropbox.pathLower': 'hashed' })
db.dropboxProjects.createIndex({ userId: 1, projectId: 1 }, { name: 'projectId_userId_1', unique: true })
db.dropboxProjects.createIndex({ userId: 1, dropboxId: 1 }, { name: 'userId_dropboxId_1', unique: true })

Ponowne uruchomienie jest nieszkodliwe: MongoDB pomija indeksy, które już istnieją.

Nie uruchamiaj zamiast tego migracji dropboxEntities z tools/migrations: 20220825160708_recreate_dropboxEntities usuwa kolekcję, co kasuje stan synchronizacji każdego użytkownika.

​

Webhook

Dropbox informuje Overleaf o zmianach w Dropbox za pomocą webhooka, dzięki czemu pojawiają się one w Overleaf w ciągu kilku sekund. Webhook jest kierowany na adres Twojej witryny, ${OVERLEAF_SITE_URL}/dropbox/webhook, i nie wymaga dodatkowego portu, ale Dropbox musi mieć do niego dostęp z internetu. Gdy dodasz go w App Console, Dropbox od razu go sprawdza.

Bez webhooka, na przykład na serwerze niedostępnym dla Dropbox, zmiany w Overleaf są nadal wysyłane do Dropbox, ale zmiany w Dropbox wracają tylko wtedy, gdy użytkownik kliknie sync this project now w oknie Dropbox w edytorze.

​

Jak działa synchronizacja

• Łączenie: gdy użytkownik połączy swoje konto Dropbox, projekty, których jest właścicielem, są wysyłane do Dropbox. Projekty udostępnione mu pojawiają się w Dropbox przy ich następnej zmianie.
• Z Overleaf do Dropbox: nowe pliki, zmiany nazw, przeniesienia, usunięcia i zmiany nazw projektów są wysyłane natychmiast. Zmiany w edytorze są wysyłane, gdy Overleaf zapisze je w swoim magazynie, kilka minut po tym, jak wszyscy opuszczą projekt. Aby wysłać je wcześniej, kliknij sync this project now w oknie Dropbox w edytorze (raz na minutę).
• Z Dropbox do Overleaf: nowe i zmienione pliki, nowe foldery oraz usunięcia w folderze projektu są stosowane w projekcie. Nowy folder na najwyższym poziomie folderu aplikacji staje się nowym projektem. Usunięcie folderu projektu w Dropbox oznacza projekt jako usunięty w Overleaf.
• Konflikty: gdy plik zmieni się w obu miejscach jednocześnie, wygrywa ostatnia zmiana. Dropbox może zachować drugą wersję jako conflicted copy.
• Współpracownicy: współpracownicy, którzy połączą swój Dropbox, otrzymują udostępnione im projekty. Osoby z dostępem tylko do odczytu i recenzenci otrzymują projekt, ale ich zmiany w Dropbox nie są synchronizowane z powrotem do Overleaf.
• Ignorowane pliki: pliki, których Overleaf nie synchronizuje, takie jak wyniki kompilacji (.aux, .log, …), .DS_Store czy środowiska wirtualne Python, pozostają tylko w Dropbox.

​

Pytania i odpowiedzi

Dlaczego użytkownik nie może połączyć swojego konta Dropbox?

• Folder Dropbox, którego Overleaf jeszcze nie zna, jest dopasowywany do projektu według nazwy, więc użytkownik, którego projekty mają wspólną nazwę, zostanie poproszony o wcześniejszą zmianę ich nazw. Nazwy są porównywane bez rozróżniania wielkości liter, a projekty zarchiwizowane i przeniesione do kosza również są brane pod uwagę.
• Konto Dropbox można połączyć tylko z jednym kontem Overleaf.

Dlaczego konto Dropbox zostało odłączone?

Odpowiedź: Overleaf odłącza konto Dropbox, gdy Dropbox odrzuci jego token (na przykład po usunięciu aplikacji przez użytkownika w Dropbox), gdy Dropbox jest pełny lub gdy Dropbox zawiesił konto. Powiadomienie na liście projektów informuje użytkownika, która z tych sytuacji wystąpiła, dopóki ponownie nie połączy konta. Użytkownik może ponownie połączyć konto po rozwiązaniu problemu.

Czy mogę zmienić nazwę folderu projektu w Dropbox?

Odpowiedź: Zamiast tego zmień nazwę projektu w Overleaf: nazwa jego folderu w Dropbox również się zmieni. Dla Overleaf zmiana nazwy folderu w Dropbox oznacza usunięcie folderu projektu i utworzenie nowego, więc stary projekt zostaje oznaczony jako usunięty, a z plików tworzony jest nowy projekt.

Dlaczego niektóre foldery projektów są ponumerowane, np. „Thesis (1)”?

Odpowiedź: Każdy projekt ma własny folder, także wtedy, gdy dwa projekty mają tę samą nazwę. Dropbox nie może przechowywać dwóch folderów o tej samej nazwie, więc dodaje numer do folderu utworzonego później. Numer zależy od tego, które nazwy były w danym momencie wolne w Dropbox, a nie od tego, który projekt jest starszy. Overleaf zna folder każdego projektu, więc zmiany nigdy nie trafiają do folderu innego projektu o tej samej nazwie.

Przesłany projekt, którego nazwa jest już zajęta, również otrzymuje w Overleaf nazwę z numerem, na przykład „Thesis (1)”.

Co się stanie, gdy usunę folder projektu w Dropbox?

• Jeśli żaden inny projekt nie ma nazwy tego folderu, projekt zostaje oznaczony w Overleaf jako usunięty. Jego pliki i historia są zachowywane.
• Jeśli tę nazwę ma kilka projektów, Overleaf nie jest w stanie określić, do którego z nich należał folder. Odłącza konto Dropbox i wyświetla powiadomienie z prośbą o zmianę nazw projektów. Nadaj projektom różne nazwy przed usunięciem ich folderów w Dropbox.
• Ponumerowany folder, taki jak „Thesis (1)”, nie pasuje do żadnej nazwy projektu, więc jego usunięcie nie zmienia projektu w Overleaf. Kliknij sync this project now w oknie Dropbox w edytorze, aby ponownie wysłać projekt do Dropbox.

Co dzieje się w Dropbox, gdy usunę projekt w Overleaf?

Odpowiedź: Nic, jego folder pozostaje w Dropbox. Usuń folder w Dropbox, jeśli nie jest już potrzebny.

Co dzieje się ze zmianami w Dropbox, gdy projekt jest zarchiwizowany lub w koszu?

Odpowiedź: Nie są one stosowane w projekcie, a przywrócenie projektu również ich nie wprowadza. Po przywróceniu Overleaf przestaje wysyłać swoje zmiany plików, które w międzyczasie zmieniono w Dropbox, więc obie strony się różnią.

Aby ponownie zsynchronizować taki plik, zapisz go jeszcze raz w Dropbox. Overleaf przyjmie wtedy wersję z Dropbox: zmiany wprowadzone w pliku w Overleaf od czasu przywrócenia zostaną zastąpione i pozostaną w historii projektu. Przywróć projekt, zanim zmienisz go w Dropbox.

Dlaczego link do Dropbox w edytorze otwiera stronę główną Dropbox?

Odpowiedź: Link prowadzi do Apps/<app folder>/<project> na dropbox.com, tak jak w Overleaf Cloud. Gdy Dropbox wyświetla folder Apps pod przetłumaczoną nazwą, na przykład 应用 po chińsku, link nie znajduje folderu i Dropbox otwiera zamiast tego swoją stronę główną. Otwórz folder projektu z przetłumaczonego folderu Apps w Dropbox.

Dlaczego w Dropbox brakuje niektórych plików projektu?

Odpowiedź: Zmiany wprowadzone, gdy usługa synchronizacji nie działała, na przykład podczas jej ponownego uruchamiania, nie są później wysyłane do Dropbox. Kliknij sync this project now w oknie Dropbox w edytorze: ponownie wysyła cały projekt.