diff --git a/docs/.pages b/docs/.pages index ef1618b0b..deb426f80 100644 --- a/docs/.pages +++ b/docs/.pages @@ -4,4 +4,5 @@ nav: - pilots-corner - dev-corner - simbridge + - installer - release-notes diff --git a/docs/fbw-a32nx/support/reported-issues.md b/docs/fbw-a32nx/support/reported-issues.md index 8ba9a7374..d22f40fdb 100644 --- a/docs/fbw-a32nx/support/reported-issues.md +++ b/docs/fbw-a32nx/support/reported-issues.md @@ -7,7 +7,9 @@ *Most reported issues are caused by conflicts with other mods and liveries. If this does not resolve your issue, please continue below.* - **Throttle Calibration is Required** - [Guide Here](../feature-guides/flypados3/throttle-calibration.md) + - **Throttle Calibration is Required** - [Guide Here](../feature-guides/flypados3/throttle-calibration.md) + + - **FBW Installer Issues** - [Guide Here](../../installer/reported-issues.md) --- @@ -72,7 +74,6 @@ TEMPLATE |:---------------------------------------------------------------------------------------| | [Commonly Reported Issues](#commonly-reported-issues) | | [Solutions to Commonly Reported Issues](#solutions-to-commonly-reported-issues) | -| [FBW Installer Issues](#fbw-installer-issues) | | [Incompatible and Problematic Add-ons/Mods](#incompatible-and-problematic-add-onsmods) | ## Use the Browser's Search Function @@ -1002,66 +1003,6 @@ Please try these before reporting any other issue on Discord. This is an MSFS issue sometimes triggered by pushback tools like Toolbar Pushback Add-on and the flyPad pushback system. - -## FBW Installer Issues - -??? bug "Download Issues - FBW Products" - ### Download Issues - FBW Products - - ^^Description^^ - - In certain situations, your ISP may block our CDN (Content Distribution Network) served by Cloudflare. Cloudflare allows us to save costs when users download our aircraft from our installer to - provide a seamless installation process for a variety of our products. - - Additionally, any disturbance to the stability of your connection may cause any downloads to fail and may need to be retried when you have a more stable connection. - - ^^Common Error Codes^^ - - - ECONNRESET - - ETIMEDOUT - - ENOTFOUND - - HTTP 403 - - ^^Possible Solution or Workaround^^ - - We recommend one of the following actions: - - 1. TEMPORARY Solution: Try a VPN - a great free one that's reliable is [ProtonVPN](https://protonvpn.com/). - - Please do your own due diligence and research when utilizing a VPN, even with our recommended one above. - 2. Download a full build from our website [here]() - Please ensure you follow our [manual installation instructions](../installation.md#manual-installation). - 3. Contact your ISP to check with them if there are any existing issues utilizing Cloudflare on their network. - - ^^Additional Information^^ - - Below is a list of countries that are possibly affected by this issue. Please note that it may not be *every* ISP in the country. - - - Brazil - - China - - Iberia - - Portugal - - Saudi Arabia - - Spain - -??? bug "Installer Permission Problems" - ### Installer Permission Problems - - ^^Description^^ - - During installation of a product a "Windows Permission Error" with the error code EPERM shows up and the installation is aborted. - - ^^Root Cause^^ - - Sometimes the permissions of the community folder are set to not allow the current user to install addons in it. - This might be set since the installation of MSFS or MSFS might have changed it at some point. - - ^^Possible Solution or Workaround^^ - - One of the following solutions usually lets the desired addon be installed - - * Check the permissions of the community folder and correct them. - * Rename the current community folder, create a new one with the same name and move your installed addons into the new community folder. - * Start the installer with admin permissions. - ## Incompatible and Problematic Add-ons/Mods The following add-ons and mods are known to be incompatible and cause issues with the A32NX. We recommend you uninstall these before starting the sim and flying with the A32NX, especially if you experience issues with the aircraft. diff --git a/docs/installer/.pages b/docs/installer/.pages new file mode 100644 index 000000000..76bb9a220 --- /dev/null +++ b/docs/installer/.pages @@ -0,0 +1,9 @@ +# Edit this page to get: +# - Title for the whole directory +# - Titles for specific pages or subdirectories +# - Order of pages (otherwise alphabetical order) + +title: FlyByWire Installer +nav: + - Overview: index.md + - ... \ No newline at end of file diff --git a/docs/installer/index.md b/docs/installer/index.md new file mode 100644 index 000000000..50444a1f5 --- /dev/null +++ b/docs/installer/index.md @@ -0,0 +1,24 @@ +--- +title: FBW Installer - Overview +description: Section dedicated to documenting the setup and use of the FlyByWire Installer. +--- + + + +# FBW Installer + +The FlyByWire Installer is a tool that allows you to install and update the FlyByWire aircraft and its dependencies such as SimBridge, as well as selected 3rd party Aircraft and Tools. It is a standalone application that is +separate from the aircraft itself. + +[Known Issues + Troubleshooting Here](reported-issues.md){.md-button} + +## 3rd Party Aircraft and Tools + +Specific 3rd party aircraft and tools we have collaborated with are also available in the installer. These are not developed by FlyByWire, but we have worked with the +developers in various capacities in the spirit of open source collaboration. You can find a list below: + +| Team | Product | Status | +|:----------------------------------------------------------------------------|:-------------------------------------------------|:---------------:| +| Salty Simulations [Discord](https://discord.com/invite/S4PJDwk){target=new} | Aircraft - 74S (Boeing 747-8i) | Released | +| [FSLTL](https://www.fslivetrafficliveries.com/){target=new} | Standalone Real-Time traffic and livery matching | Released | +| [Synaptic Simulations](https://www.synapticsim.com/){target=new} | Aircraft - A22X (Airbus A220neo) | *Not Available* | diff --git a/docs/installer/reported-issues.md b/docs/installer/reported-issues.md new file mode 100644 index 000000000..8b01f0d06 --- /dev/null +++ b/docs/installer/reported-issues.md @@ -0,0 +1,99 @@ +# Installer Reported Issues + + +!!! tip "" + FBW Installer - [Download Here](https://api.flybywiresim.com/installer){target=new} + +!!! info "General Issues" + If you are experiencing issues with our aircraft please visit the following pages: + + - [Known Issues](../fbw-a32nx/support/reported-issues.md) + - [Support Guide](../fbw-a32nx/support/index.md) + - [FAQ](../fbw-a32nx/faq.md) + +--- + + + +## Use the Browser's Search Function + +On Desktop, press ++ctrl+'F'++ to search for an issue within the current page. + +## Legend + +!!! bug "Breaking Issue / Bug" +!!! warning "Non-Breaking Issue / Inconvenience" +!!! tip "Config Issue / Usage Issue" + +## FBW Installer Issues + +??? bug "Download Issues - FBW Products" + ### Download Issues - FBW Products + + ^^Description^^ + + In certain situations, your ISP may block our CDN (Content Distribution Network) served by Cloudflare. Cloudflare allows us to save costs when users download our aircraft from our installer to + provide a seamless installation process for a variety of our products. + + Additionally, any disturbance to the stability of your connection may cause any downloads to fail and may need to be retried when you have a more stable connection. + + ^^Common Error Codes^^ + + - ECONNRESET + - ETIMEDOUT + - ENOTFOUND + - HTTP 403 + + ^^Possible Solution or Workaround^^ + + We recommend one of the following actions: + + 1. TEMPORARY Solution: Try a VPN - a great free one that's reliable is [ProtonVPN](https://protonvpn.com/). + - Please do your own due diligence and research when utilizing a VPN, even with our recommended one above. + 2. Download a full build from our website [here]() - Please ensure you follow our [manual installation instructions](../fbw-a32nx/installation.md#manual-installation). + 3. Contact your ISP to check with them if there are any existing issues utilizing Cloudflare on their network. + + ^^Additional Information^^ + + Below is a list of countries that are possibly affected by this issue. Please note that it may not be *every* ISP in the country. + + - Brazil + - China + - Iberia + - Portugal + - Saudi Arabia + - Spain + +??? bug "Installer Permission Problems" + ### Installer Permission Problems + + ^^Description^^ + + During installation of a product a "Windows Permission Error" with the error code EPERM shows up and the installation is aborted. + + ^^Root Cause^^ + + Sometimes the permissions of the community folder are set to not allow the current user to install addons in it. + This might be set since the installation of MSFS or MSFS might have changed it at some point. + + ^^Possible Solution or Workaround^^ + + One of the following solutions usually lets the desired addon be installed + + * Check the permissions of the community folder and correct them. + * Rename the current community folder, create a new one with the same name and move your installed addons into the new community folder. + * Start the installer with admin permissions. diff --git a/mkdocs.yml b/mkdocs.yml index d54c4b907..10a5433bb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,6 +82,7 @@ plugins: 'installation.md': 'fbw-a32nx/installation.md' 'throttle.md': 'fbw-a32nx/feature-guides/flypados3/throttle-calibration.md' 'reported-issues.md': 'fbw-a32nx/support/reported-issues.md' + 'installer-issues.md': 'installer/reported-issues.md' 'support.md': 'fbw-a32nx/support/index.md' 'discord-bot.md': 'dev-corner/development-projects/discord-bot.md' 'airframe.md': 'https://docs.flybywiresim.com/fbw-a32nx/installation/#simbrief-airframe'