Add docs for configuration and troubleshooting

doc/DESCRIPTION_fr.md

@@ -0,0 +1 @@
+Serveur de seconde génération pour Firefox Sync écrit en Rust.

doc/POST_INSTALL.md

@@ -1 +1,22 @@
-Please open `about:config` in your Firefox and point `identity.sync.tokenserver.uri` to `https://__DOMAIN__/1.0/sync/1.5`.
+### Create a Mozilla account
+Go to https://accounts.firefox.com and follow the "Sign up" steps to create an account.
+
+### Configure Firefox Desktop
+Please open `about:config` in your Firefox and point `identity.sync.tokenserver.uri` to `https://__DOMAIN__/1.0/sync/1.5`.
+
+### Configure Firefox based browsers on Android 
+These steps have to be followed in a strict order. Failing to do it would probably lead to issues. This should also work in Firefox based browsers like Mull (tested) and others.
+- Open Firefox Browser -> Settings -> About Firefox -> tap 5 times in Firefox logo.
+- Go back to Settings -> Account -> you should see a new option `Sync Debug`, tap on it.
+- Select `Custom Sync server` and write there your endpoint. It should be `https://__DOMAIN__/1.0/sync/1.5`.
+- Exit Firefox completely, reopen and then follow the steps of "Connect a device" to your Firefox account.
+- After a successful auth process the sync should start working.
+
+### Configure Firefox on iOS
+Not tested.
+- Open Firefox Browser -> Settings -> About Firefox -> tap on the field with Firefox and version number.
+- Go back to Settings -> Account -> you should see a new option `Advanced Sync Settings`, tap on it.
+- Toggle `Use Custom Sync Token Server` and write there your endpoint. It should be `https://__DOMAIN__/`.
+- You might also need to toggle the switch for custom FxA login server and set it to `https://accounts.firefox.com`
+- Exit Firefox completely, reopen and then follow the steps of "Connect a device" to your Firefox account.
+- After a successful auth process the sync should start working.

doc/POST_INSTALL_es.md

@@ -0,0 +1,22 @@
+### Crear una cuenta Mozilla
+Vaya a https://accounts.firefox.com y siga los pasos de "Registrarse" para crear una cuenta.
+
+### Configurar Firefox Desktop
+Por favor, abra `about:config` en su Firefox y apunte `identity.sync.tokenserver.uri` a `https://__DOMAIN__/1.0/sync/1.5`.
+
+### Configurar navegadores basados en Firefox en Android
+Estos pasos deben seguirse en un orden estricto. Si no lo haces, probablemente tendrás problemas. Esto también debería funcionar en navegadores basados en Firefox como Mull (probado) y otros.
+- Abre el navegador Firefox -> Configuración -> Acerca de Firefox -> pulsa 5 veces en el logo de Firefox.
+- Vuelva a Configuración -> Cuenta -> debería ver una nueva opción `Sync Debug`, pulse sobre ella.
+- Seleccione `Servidor de sincronización personalizado` y escriba allí su endpoint. Debería ser `https://__DOMAIN__/1.0/sync/1.5`.
+- Sal completamente de Firefox, vuelve a abrirlo y sigue los pasos de "Conectar un dispositivo" a tu cuenta de Firefox.
+- Después de un exitoso proceso de autenticación, la sincronización debería empezar a funcionar.
+
+### Configurar Firefox en iOS
+No probado.
+- Abre el navegador Firefox -> Configuración -> Acerca de Firefox -> pulsa en el campo con Firefox y el número de versión.
+- Vuelve a Configuración -> Cuenta -> deberías ver una nueva opción `Configuración de sincronización avanzada`, pulsa sobre ella.
+- Cambia a `Usar Servidor de Sincronización Personalizado` y escribe allí tu endpoint. Debería ser `https://__DOMAIN__/`.
+- Es posible que también tenga que activar la opción para el servidor de inicio de sesión personalizado FxA y ponerlo en `https://accounts.firefox.com`.
+- Sal completamente de Firefox, vuelve a abrirlo y sigue los pasos de "Conectar un dispositivo" a tu cuenta de Firefox.
+- Después de un exitoso proceso de autenticación, la sincronización debería empezar a funcionar.

doc/POST_INSTALL_fr.md

@@ -0,0 +1,22 @@
+### Créer un compte Mozilla
+Allez sur https://accounts.firefox.com et suivez les étapes "Sign up" pour créer un compte.
+
+### Configurer Firefox Desktop
+Veuillez ouvrir `about:config` dans votre Firefox et pointer `identity.sync.tokenserver.uri` vers `https://__DOMAIN__/1.0/sync/1.5`.
+
+### Configurer des navigateurs basés sur Firefox sur Android
+Ces étapes doivent être suivies dans un ordre strict. Ne pas le faire conduirait probablement à des problèmes. Cela devrait également fonctionner avec les navigateurs basés sur Firefox comme Mull (testé) et d'autres.
+- Ouvrez le navigateur Firefox -> Paramètres -> À propos de Firefox -> tapez 5 fois sur le logo Firefox.
+- Retournez dans Paramètres -> Compte -> vous devriez voir une nouvelle option `Sync Debug`, tapez dessus.
+- Sélectionnez `Custom Sync server` et écrivez votre endpoint. Ce devrait être `https://__DOMAIN__/1.0/sync/1.5`.
+- Quittez complètement Firefox, reouvrez-le et suivez les étapes de "Connecter un appareil" à votre compte Firefox.
+- Après un processus d'authentification réussi, la synchronisation devrait commencer à fonctionner.
+
+### Configurer Firefox sur iOS
+Non testé.
+- Ouvrez le navigateur Firefox -> Paramètres -> A propos de Firefox -> tapez sur le champ avec Firefox et le numéro de version.
+- Retournez à Paramètres -> Compte -> vous devriez voir une nouvelle option `Paramètres de synchronisation avancés`, appuyez dessus.
+- Basculez sur `Use Custom Sync Token Server` et écrivez votre endpoint. Il devrait être `https://__DOMAIN__/`.
+- Vous pourriez aussi avoir besoin de basculer l'interrupteur pour le serveur de connexion FxA personnalisé et de le mettre à `https://accounts.firefox.com`
+- Quittez complètement Firefox, rouvrez-le et suivez les étapes de "Connecter un appareil" à votre compte Firefox.
+- Après un processus d'authentification réussi, la synchronisation devrait commencer à fonctionner.

doc/TROUBLESHOOTING.md

@@ -0,0 +1,16 @@
+## Troubleshooting
+This guide provides a good walkthrough and insights: https://thesmarthomejourney.com/2023/03/18/self-hosting-firefox-sync/
+
+### Server
+Log file is located in `/var/log/syncserver-rs/syncserver-rs.log`.
+
+### Firefox Desktop
+If for some reason there is a problem with the sync configuration, there is the possibility to visit `about:sync-logs` in a new tab and if any error occurs, it will be displayed there.
+
+### Firefox Android
+Keep in mind that if you make a typo on the `Custom Sync server` setting or if you do the steps in a different order it probably won't work.
+So if that is the case, logout any existing session related to the failed attempt in https://accounts.firefox.com/settings and reset Firefox Android (Open Firefox in app list and "Clear all data" from Android Settings).
+
+### Firefox iOS
+Keep in mind that if you make a typo on the `Use Custom Sync Token Server` setting or if you do the steps in a different order it probably won't work.
+So if that is the case, logout any existing session related to the failed attempt in https://accounts.firefox.com/settings and reset Firefox iOS.

doc/TROUBLESHOOTING_es.md

@@ -0,0 +1,16 @@
+## Solución de problemas
+Esta guía puede resultar útil para problemas relacionados con la configuración: https://thesmarthomejourney.com/2023/03/18/self-hosting-firefox-sync/
+
+### Servidor
+El archivo de logs se encuentra en `/var/log/syncserver-rs/syncserver-rs.log`.
+
+### Firefox Desktop
+Si por alguna razón hay un problema con la configuración de la sincronización, existe la posibilidad de visitar `about:sync-logs` en una nueva pestaña y si se produce algún error, se mostrará allí.
+
+### Firefox Android
+Ten en cuenta que si cometes un error tipográfico en la configuración de `Servidor de sincronización personalizado` o si realizas los pasos en un orden diferente, probablemente no funcionará.
+Así que si ese es el caso, cierra cualquier sesión existente relacionada con el intento fallido en https://accounts.firefox.com/settings y reinicia Firefox Android (Abre Firefox en la lista de aplicaciones y busca la opción "Borrar todos los datos" desde los Ajustes de Android).
+
+### Firefox iOS
+Ten en cuenta que si cometes un error tipográfico en el ajuste `Usar Servidor de Sincronización Personalizado` o si realizas los pasos en un orden diferente, probablemente no funcionará.
+Así que si ese es el caso, cierra cualquier sesión existente relacionada con el intento fallido en https://accounts.firefox.com/settings y reinicia Firefox iOS.

doc/TROUBLESHOOTING_fr.md

@@ -0,0 +1,16 @@
+## Résolution des problèmes
+Ce guide fournit une bonne marche à suivre et des informations : https://thesmarthomejourney.com/2023/03/18/self-hosting-firefox-sync/
+
+### Serveur
+Le fichier journal est situé dans `/var/log/syncserver-rs/syncserver-rs.log`.
+
+### Firefox Desktop
+Si pour une raison quelconque il y a un problème avec la configuration de la synchronisation, il y a la possibilité de visiter `about:sync-logs` dans un nouvel onglet et si une erreur se produit, elle sera affichée là.
+
+### Firefox Android
+Gardez à l'esprit que si vous faites une erreur de frappe dans le paramètre `Custom Sync server` ou si vous faites les étapes dans un ordre différent, cela ne fonctionnera probablement pas.
+Si c'est le cas, déconnectez-vous de toute session existante liée à la tentative échouée dans https://accounts.firefox.com/settings et réinitialisez Firefox Android (Ouvrez Firefox dans la liste des applications et "Effacer toutes les données" depuis les paramètres Android).
+
+### Firefox iOS
+Gardez à l'esprit que si vous faites une erreur de frappe dans le paramètre `Use Custom Sync Token Server` ou si vous faites les étapes dans un ordre différent, cela ne fonctionnera probablement pas.
+Si c'est le cas, déconnectez-vous de toute session existante liée à la tentative échouée dans https://accounts.firefox.com/settings et réinitialisez Firefox iOS.