diff --git a/docs/setup.md b/docs/setup.md index 0c464d2..5a32783 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -22,10 +22,33 @@ Once the executable file is located on your workstation, start it ! chicken-bot.exe ``` -Note: this application embeds chromium browser and could taks so much time to appears especially the first time. Be patient. +- ➡️ cf. Notice about performances +- ➡️ cf. Notice about security A desktop application popup must appears. You're in ! Continue by reading **[bot user guide](/docs/category/user-guide)**. To get more advanced tips about setup, cf. [this page](./setup-advanced.md). + +### Notice about performances +This application is an [ElectronJS](https://www.electronjs.org/) desktop application that embeds Chromium browser and could takes so much time to appears especially the first time. Be patient. + +### Notice about general security +As this application is an executable you must be warn of this commons rules: +- you must always retrieve official binaries from official websites. For chicken-bot, the official resource is chickenbot-web/release : https://github.com/chickarmy/chickenbot-web/releases. This resource site is used by [official website](https://chickarmy.github.io/chickenbot-web/fr/). +- you must always double-check binary BEFORE executing them from your local anti-virus / anti-malware application and trusted on-line services. One good way to do that is to drop any downloaded files onto https://virustotal.com website and wait for full analysis from different security providers. +- ➡️ You may notice that chicken-bot exe produces a false positive from `Bkav pro` security provider (cf. ticket [#49](https://github.com/chickarmy/chickenbot-web/issues/49)). + +### Notice about MS Windows security + +As chicken-bot executable is NOT coming from Microsoft trusted source, Windows will produce some popup to warn you. You must accept them in order to launch app. + +![windowsProtect.JPG](../static/img/windowsProtect.JPG) + +➡️ click on "Informations complémentaires" + + +![windowsProtect2.JPG](../static/img/windowsProtect2.JPG) + +➡️ click on "Exécuter quand même" (only when you're confident regarding security analysis). \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 77ca5ab..01c6fb1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -103,13 +103,15 @@ const config = { { title: 'Docs', items: [ - {label: 'Intro', to: '/docs/intro'}, + {label: 'Install', to: '/docs/setup'}, + {label: 'Guide', to: '/docs/category/user-guide'}, ], }, { title: 'Community', items: [ - {label: 'Stack Overflow', href: 'https://stackoverflow.com/questions/tagged/chickenbot'}, + {label: 'discussions [en/fr]', href: 'https://github.com/chickarmy/chickenbot-web/discussions'}, + // {label: 'Stack Overflow', href: 'https://stackoverflow.com/questions/tagged/chickenbot'}, // {label: 'Discord',href: 'https://discordapp.com/invite/docusaurus'}, // {label: 'Twitter',href: 'https://twitter.com/docusaurus'}, ], diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/setup.md b/i18n/fr/docusaurus-plugin-content-docs/current/setup.md index e09bc3c..ca2d305 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/setup.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/setup.md @@ -12,7 +12,7 @@ Accédez à la page d'accueil de ce site Web pour télécharger la dernière ver ➡️ https://chickarmy.github.io/chickenbot-web/ -## Premier démarrage de chicken-bot +## Premier démarrage du Chicken-bot Une fois le fichier exécutable localisé sur votre poste de travail, démarrez-le ! @@ -20,10 +20,36 @@ Une fois le fichier exécutable localisé sur votre poste de travail, démarrez- chicken-bot.exe ``` -Remarque : cette application intègre le navigateur Chromium et peut prendre beaucoup de temps à apparaître, surtout la première fois. Soyez patient. +- ➡️ cf. Avis sur les performances +- ➡️ cf. Avis sur la sécurité + +Une popup d'application de bureau doit apparaître. Vous y êtes ! + +Continuez en lisant **[le guide d'utilisation du bot](/docs/category/user-guide)**. + +Pour obtenir des conseils plus avancés sur la configuration, cf. [cette page](./setup-advanced.md). + +### Avis sur les performances +Cette application est une application de bureau [ElectronJS](https://www.electronjs.org/) qui intègre le navigateur Chromium et peut prendre beaucoup de temps à apparaître surtout la première fois. Soyez patient. + +### Avis de sécurité général +Comme cette application est un exécutable, vous devez être averti de ces règles communes de sécurité : +- vous devez toujours récupérer les binaires officiels à partir des sites Web officiels. Pour chicken-bot, la ressource officielle est chickenbot-web/release : https://github.com/chickarmy/chickenbot-web/releases. Ce site de ressources est utilisé par [site Web officiel](https://chickarmy.github.io/chickenbot-web/fr/). +- vous devez toujours revérifier les binaires AVANT de les exécuter à partir de votre application antivirus / anti-malware locale et services en ligne de confiance. Une bonne façon de le faire est de déposer tous les fichiers téléchargés sur le site Web https://virustotal.com et d'attendre une analyse complète de différents fournisseurs de sécurité. +- ➡️ Vous remarquerez peut-être que chicken-bot exe produit un faux positif du fournisseur de sécurité `Bkav pro` (cf. ticket [#49](https://github.com/chickarmy/chickenbot-web/issues/49)). + +### Avis de sécurité MS Windows +Comme l'exécutable chicken-bot ne provient PAS d'une source fiable de Microsoft, Windows produira des popups pour vous avertir. Vous devez les accepter pour lancer l'application. + + +![windowsProtect.JPG](../../../../static/img/windowsProtect.JPG) + +➡️ cliquez sur "Informations complémentaires" + + +![windowsProtect2.JPG](../../../../static/img/windowsProtect2.JPG) + +➡️ cliquez sur "Exécuter quand même" (uniquement lorsque vous êtes sûr de l'analyse de sécurité). -Une fenêtre d'application de bureau doit apparaître. Vous y êtes ! -Continuez en lisant **[guide d'utilisation du bot](/docs/category/user-guide)**. -Pour obtenir des conseils plus avancés sur la configuration, cf. [cette page](./setup-advanced.md). \ No newline at end of file diff --git a/static/img/windowsProtect.JPG b/static/img/windowsProtect.JPG new file mode 100644 index 0000000..0f9504d Binary files /dev/null and b/static/img/windowsProtect.JPG differ diff --git a/static/img/windowsProtect2.JPG b/static/img/windowsProtect2.JPG new file mode 100644 index 0000000..4bd2089 Binary files /dev/null and b/static/img/windowsProtect2.JPG differ