Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add top level installer section + pages #878

Draft
wants to merge 7 commits into
base: primary
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ nav:
- pilots-corner
- dev-corner
- simbridge
- installer
- release-notes
65 changes: 3 additions & 62 deletions docs/fbw-a32nx/support/reported-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/installer/.pages
Original file line number Diff line number Diff line change
@@ -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
- ...
24 changes: 24 additions & 0 deletions docs/installer/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: FBW Installer - Overview
description: Section dedicated to documenting the setup and use of the FlyByWire Installer.
---

<link rel="stylesheet" href="../../stylesheets/toc-tables.css">

# FBW Installer

The FlyByWire Installer is a tool that allows you to install and update the FlyByWire aircraft and its dependencies such as SimBridge. It is a standalone application that is
separate from the aircraft itself.
Valastiri marked this conversation as resolved.
Show resolved Hide resolved

[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* |
99 changes: 99 additions & 0 deletions docs/installer/reported-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Installer Reported Issues

<link rel="stylesheet" href="/stylesheets/toc-tables.css">
!!! 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)

---

<!--

TEMPLATE

??? issue "Issue Headline"

!!! tip ""
*Affected versions: Stable, Development*

^^Description^^
^^Root Cause^^
^^Possible Solution or Workaround^^
^^Additional Information^^

-->

## 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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down