164 lines
10 KiB
PHP

<?php
/**
* FavMasToKey - Documentation d'utilisation
*/
// Définir la constante pour inclure les fichiers
define('FAVMASTOKEY', true);
// Inclure les fichiers requis
require_once 'includes/config.php';
?>
<!DOCTYPE html>
<html lang="fr" data-bs-theme="dark">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#7e57c2">
<link rel="icon" href="images/favicon.svg" type="image/svg+xml">
<meta name="description" content="FavMasToKey - Documentation d'utilisation pour transférer vos favoris de Mastodon vers Misskey">
<title>Documentation - FavMasToKey</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="css/styles.css">
</head>
<body>
<div class="container py-5">
<header class="text-center mb-5">
<h1>FavMasToKey</h1>
<p class="lead">Documentation d'utilisation</p>
<p><a href="index.php" class="btn btn-primary">Retour à l'application</a></p>
</header>
<div class="row justify-content-center">
<div class="col-md-10">
<div class="card shadow-sm mb-4">
<div class="card-body">
<h2 class="card-title">Guide étape par étape</h2>
<h3>1. Préparation</h3>
<div class="mb-4">
<h4>1.1 Obtenir vos favoris depuis Mastodon</h4>
<ol>
<li>Connectez-vous à votre compte Mastodon</li>
<li>Allez dans <strong>Préférences</strong> > <strong>Exporter et importer</strong></li>
<li>Dans la section <strong>Exporter</strong>, cliquez sur <strong>Demander vos favoris</strong></li>
<li>Une fois le fichier prêt, téléchargez-le</li>
</ol>
<h4>1.2 Préparer votre compte Misskey</h4>
<ol>
<li>Assurez-vous d'être connecté à votre compte Misskey</li>
<li>Vérifiez que vous avez suffisamment d'espace pour de nouveaux favoris</li>
</ol>
</div>
<h3>2. Utilisation de FavMasToKey</h3>
<div class="mb-4">
<h4>2.1 Télécharger le fichier JSON</h4>
<ol>
<li>Sur la page d'accueil de FavMasToKey, cliquez sur "Parcourir" pour sélectionner votre fichier JSON de favoris</li>
<li>Cliquez sur "Analyser le fichier" pour continuer</li>
</ol>
<h4>2.2 Connexion à votre compte Misskey</h4>
<ol>
<li>Entrez l'URL de votre instance Misskey (ex: misskey.io)</li>
<li>Générez un jeton d'accès depuis les paramètres de votre compte Misskey:
<ol type="a">
<li>Connectez-vous à votre compte Misskey</li>
<li>Allez dans <strong>Paramètres</strong> > <strong>API</strong></li>
<li>Cliquez sur <strong>Générer un nouveau jeton d'accès</strong></li>
<li>Donnez un nom à votre jeton (ex: "FavMasToKey")</li>
<li>Accordez les permissions suivantes :
<ul>
<li><strong>Afficher les informations du compte</strong></li>
<li><strong>Afficher les favoris</strong></li>
<li><strong>Gérer les favoris</strong></li>
</ul>
</li>
<li>Cliquez sur <strong>Générer</strong> et copiez le jeton</li>
</ol>
</li>
<li>Collez le jeton d'accès dans le champ correspondant</li>
<li>Cliquez sur "Se connecter à Misskey" pour continuer</li>
</ol>
<h4>2.3 Migration des favoris</h4>
<ol>
<li>Une fois l'autorisation accordée, vous serez redirigé vers l'écran de migration</li>
<li>Cliquez sur "Démarrer la migration" pour commencer le processus</li>
<li>Vous pouvez mettre en pause, reprendre ou annuler la migration à tout moment</li>
<li>Le journal des opérations vous montre l'état de chaque favori traité</li>
</ol>
</div>
<h3>3. Résolution des problèmes courants</h3>
<div class="mb-4">
<h4>3.1 Publications non trouvées</h4>
<p>Certaines publications peuvent ne pas être trouvées sur le réseau fédéré pour diverses raisons :</p>
<ul>
<li>La publication a été supprimée</li>
<li>L'instance d'origine est hors ligne</li>
<li>L'utilisateur a changé ses paramètres de confidentialité</li>
<li>Votre instance Misskey ne s'est jamais fédérée avec l'instance d'origine</li>
</ul>
<p>Solution : Malheureusement, il n'y a pas de solution simple pour ce problème, car il s'agit d'une limitation du réseau fédéré. Vous pouvez essayer de visiter manuellement les URLs qui ont échoué.</p>
<h4>3.2 Erreurs d'authentification</h4>
<p>Si vous rencontrez des problèmes avec votre jeton d'accès :</p>
<ul>
<li>Vérifiez que vous avez copié le jeton entier et sans espaces supplémentaires</li>
<li>Assurez-vous d'avoir sélectionné les permissions correctes lors de la génération du jeton</li>
<li>Essayez de générer un nouveau jeton d'accès</li>
<li>Vérifiez que votre instance Misskey est accessible et fonctionne correctement</li>
</ul>
<h4>3.3 Migration interrompue</h4>
<p>Si votre migration est interrompue (par exemple, en fermant l'onglet ou en perdant la connexion Internet), FavMasToKey peut la reprendre :</p>
<ul>
<li>Retournez simplement sur la page de FavMasToKey</li>
<li>Authentifiez-vous à nouveau si nécessaire</li>
<li>L'application détectera automatiquement la migration en cours</li>
<li>Confirmez que vous souhaitez reprendre là où vous vous êtes arrêté</li>
</ul>
</div>
</div>
</div>
<div class="card shadow-sm">
<div class="card-body">
<h2 class="card-title">Informations techniques</h2>
<h3>Comment ça marche ?</h3>
<p>FavMasToKey fonctionne en suivant ces étapes :</p>
<ol>
<li><strong>Analyse du fichier JSON</strong> - L'application extrait les URLs des favoris depuis votre fichier Mastodon</li>
<li><strong>Authentification par jeton</strong> - L'application utilise le jeton d'accès que vous avez généré pour s'authentifier auprès de votre instance Misskey</li>
<li><strong>Recherche fédérée</strong> - Pour chaque favori, l'application recherche la publication équivalente sur le réseau fédéré</li>
<li><strong>Ajout aux favoris</strong> - Si la publication est trouvée, elle est ajoutée à vos favoris Misskey</li>
</ol>
<h3>Confidentialité et sécurité</h3>
<p>FavMasToKey a été conçu en mettant l'accent sur la confidentialité et la sécurité :</p>
<ul>
<li>Aucune donnée n'est stockée sur le serveur, tout est traité localement dans votre navigateur</li>
<li>Les jetons d'accès sont temporaires et ne sont stockés que pendant la durée de votre session</li>
<li>Le code est open source et peut être audité</li>
<li>L'application ne demande que les permissions minimales nécessaires (ajouter aux favoris)</li>
</ul>
<h3>Limitations connues</h3>
<ul>
<li>Les publications qui n'existent plus ou qui sont privées ne peuvent pas être retrouvées</li>
<li>Les instances Misskey peuvent avoir des limites de taux (rate limits) qui ralentissent le processus</li>
<li>Les grandes collections de favoris peuvent prendre du temps à migrer</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
</body>
</html>