FYS-App installation is available for several platforms. Currently the recommended method for running FYS-App, is by using the Docker image as it provides a simple and secure method for the application to run on multiple operating systems (Windows, Linux, and MacOS)
Installation Guide (Docker):
1- Before you can run FYS-App in a Docker Container, you need to have Docker on your system. If you already have Docker, skip to step 2.
If, you don’t have Docker installed on your system, you need to install Docker by following the process from: Docker Desktop. The instructions for installing Docker, are different depending on your operating system. Also, your platform must meet the system requirements for Docker.
Docker for Windows requires Microsoft WSL2 and a Linux Distro installed. This video shows how to install WSL2/Ubuntu and Docker: https://www.youtube.com/watch?v=njLEhbuLDIg
2- With Docker installed on your system, visit the page for fys-alpine and follow the instructions to get the image and run it: jrvela/fys-alpine
3- FYS-App requires a Product Key to access live data. The key is free and can be obtained from within the FYS-App‘s login button. You will need to save the key in the FYS-App>Settings. For details please see: How-to: Get a Product Key – Ducky Soup
Note: At this time, sound is not supported in the Docker image.
Installing FYS-App directly on Linux and Mac OSX
FYS-App is written in Python, which makes it portable across Operating systems. However, given that there are many variations of OS’s, available specific instructions for each system are nearly impossible. Please see below for more details.
Installation Guide (Linux):
The following instructions make use of an installation script. The script installs Python in a virtual environment to avoid conflicts. The script will also install all required packages. As a security measure, you may download and inspect the script to ensure that it is doing what it is supposed to be doing.
1- The script was tested on Debian 11/12 and Ubuntu 24, but it may also work on current Linux distros based on Debian and Ubuntu. Some users have reported to have Successfully, run the script on Ubuntu-based systems: LinuxLite, Pop!_OS, and Elements OS.
2- You will need “sudo” access for the installation, otherwise the script will not run.
3- In a shell issue the following command:
sudo apt -y install curl ; sh
Note: Running scripts blindly is considered a risk. It is highly recommended to review the script content before running it. Here is a link to the script for review: https://www.duckysoup.com/wp-content/uploads/fys-app/fys-installer-Debian
4- Start fys-app using the command: ~/fys-app/run-fys
Once the application starts select the Settings button to customize your FYS-App Setting. Mandatory fields (don’t leave them blank) are the browser, the output directory and file name for the Live watchlist. If you want sound, select a WAV file as well. This sound file will play each time the Live watchlist is updated. Once you save the Settings, click on the FYS Live Scanner button.
Installation Guide Mac OSX (FYS-App v 19.0 [Jan. 1, 2024])
For the Mac OSX installation, Homebrew is a requirement. The instructions are provided below:
1- Install Homebrew by getting the installer from Homebrew — The Missing Package Manager for macOS
2- Follow the instructions on the Homebrew installer. There will be a number of prompts that you will have to answer.
Note: Installing Homebrew may take a while to execute if you are using an older Mac. Be patient.
Once the installation completes, validate that Homebrew is installed is by issuing the following command:
brew helpThis should return a help screen for the brew commands available.
3- With Homebrew operational, you can now execute the installation script:
brew install curl ; sh
Note: Running scripts blindly is considered a risky. It is highly recommended to review the script content before running it. Here is a link to the script for review: https://www.duckysoup.com/wp-content/uploads/fys-app/fys-installer-MacOS
4- Start fys-app using the command: ~/fys-app/run-fys
Once the application starts select the Settings button to customize your FYS-App Setting. Mandatory fields (don’t leave them blank) are the browser, the output directory and file name for the Live watchlist. If you want sound, select a WAV file as well. This sound file will play each time the Live watchlist is updated. Once you save the Settings, click on the FYS Live Scanner button.
Note: Python GUI controls in Mac OS X are a little different than Windows and Linux. This area will have to be improved in a future release.