Skip to content

Commit

Permalink
Fix #64 add perf & security notices
Browse files Browse the repository at this point in the history
  • Loading branch information
boly38 committed Dec 8, 2024
1 parent 9009c3d commit 3467939
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 8 deletions.
25 changes: 24 additions & 1 deletion docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
6 changes: 4 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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'},
],
Expand Down
36 changes: 31 additions & 5 deletions i18n/fr/docusaurus-plugin-content-docs/current/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,44 @@ 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 !

```bash
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).
Binary file added static/img/windowsProtect.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/windowsProtect2.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3467939

Please sign in to comment.