> ## Documentation Index > Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt > Use this file to discover all available pages before exploring further. # Supported operating systems The AppSignal integrations for Ruby, Elixir & Node.js contain native extensions and a separate lightweight agent process. These native extensions are supported on most Linux distributions, FreeBSD and macOS/OSX. Our Go and Python integrations only use our agent process and don't require additional packages to be installed. Like the other integrations, they only work on the supported Operating Systems listed in the [support table](#support-table). If an Operating System you use is not supported, please [get in touch][support]. ## Support table Table of different Operating Systems and architecture combinations we support. Check the notes below the table for any exceptions and version requirements. ### Integrations Our integrations include the: [Ruby gem](/ruby), [Elixir package](/elixir), [Node.js package](/nodejs) and [Python package](/python). |   | x86 32-bit | x86 64-bit | ARM 64-bit | | ------------------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | --------------------------------------------------------------------- | | [macOS/OSX](#macos) 1 | |
|
| | [Linux](#linux) | | | | |    - [Alpine Linux](#alpine-linux) | |
|
   2
| |    - [CentOS](#centos) |
|
|
| |    - [Debian / Ubuntu](#debian-ubuntu) |
|
|
| |    - [Fedora](#fedora) |
|
|
| | [FreeBSD](#freebsd) 1 3 | |
?
| | | [Microsoft Windows](#microsoft-windows)4 | | | | |    - [Subsystem for Linux](#microsoft-windows-subsystem-for-linux) | |
? 4
| | * `1`: Does not support [host metrics][host-metrics]. * `2`: Not supported for our Node.js integration. * `3`: Support level unclear, see [FreeBSD](#freeBSD). * `4`: Does not work natively on [Windows](#microsoft-windows). AppSignal does not provide official support for the [Windows Subsystem for Linux](#microsoft-windows-subsystem-for-linux). ### Components Additional components include: [Collector](/collector), [Standalone agent](/standalone-agent/installation/docker-image), [Wrap](/wrap). |   | x86 64-bit | ARM 64-bit | | ----------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | macOS/OSX |
|
| | Linux | | | |    - Alpine Linux |
1
|
1
| |    - CentOS |
|
| |    - Debian / Ubuntu |
|
| | Microsoft Windows2 | | | |    - Subsystem for Linux |
? 2
|
? 2
| | Docker image |
3
|
3
| No additional dependencies have to be installed for these components unless listed in their installation guides. * `1`: Alpine Linux is only supported by [Wrap](/wrap). * `2`: Does not work natively on [Windows](#microsoft-windows). AppSignal does not provide official support for the [Windows Subsystem for Linux](#microsoft-windows-subsystem-for-linux). * `3`: [Wrap](/wrap) is not available as a Docker image. ## Linux AppSignal tries to support Linux as best as possible, but some changes in our build process have caused some problems with supporting certain Linux distributions and versions. Our agent and extension are compiled against libc, and based on which version of libc we compile against we support certain older versions of Linux distributions and some not. ### Supported versions AppSignal support for versions of libc has changed over the past few versions of the Ruby gem and Elixir package. This is the list of version of libc/musl AppSignal was compiled against over the last version of our integrations: * AppSignal for Ruby `v1.0.0` - `v2.0.x`
AppSignal for Elixir `v0.0.x` - `v0.10.x` * libc `v2.5` * musl `N/A` * AppSignal for Ruby `v2.1.x` - `v2.3.x`
AppSignal for Elixir `v0.11.x` - `v1.3.x` * libc `N/A` - see [DNS timeouts known issue](/support/known-issues/dns-timeouts). * musl `v1.1.16` * AppSignal for Ruby `v2.4.x` and higher
AppSignal for Elixir `v1.4.x` and higher
AppSignal for Node.js `v1.0.0` and higher
AppSignal for Python `v0.1.0` and higher * libc `v2.15` * musl `v1.1.16` If your system uses an older libc version than AppSignal extension is compiled against, you will experience problems installing or running the AppSignal agent. If this is the case you can instead [opt-in to the musl build](#musl-build-override), which doesn't have this issue. This should no longer be a problem for AppSignal Ruby gem `v2.4.1` & Elixir package `v1.4.3` and higher, in these packages automatic detection for older libc versions was added and they will automatically switch to the musl build. **Warning for JRuby**: JRuby support on Alpine Linux (musl build) is supported since Ruby gem `2.8.0`. This scenario requires a dynamic build of the AppSignal extension, which is not supported for the musl build for older versions of the gem. You can see which version of libc your system uses by running the following command: `ldd --version 2>&1` Example of output on Ubuntu 12.04: ```bash Bash theme={null} $ ldd --version 2>&1 ldd (Ubuntu EGLIBC 2.15-0ubuntu10.18) 2.15 Copyright (C) 2012 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Written by Roland McGrath and Ulrich Drepper. ``` ### Musl build override To opt-in to the musl build manually, add the `APPSIGNAL_BUILD_FOR_MUSL` environment variable to your system environment before installing AppSignal and compiling your application. This environment variable is only needed if our auto detection does not detect the correct architecture. ```sh Shell theme={null} # For Ruby export APPSIGNAL_BUILD_FOR_MUSL=1 gem install appsignal # or with Bundler bundle install # For Elixir export APPSIGNAL_BUILD_FOR_MUSL=1 mix deps.get mix compile # For Node.js export APPSIGNAL_BUILD_FOR_MUSL=1 npm install # For Python # Not supported ``` ### Linux ARM build override The AppSignal packages will automatically detect ARM based hosts and select the agent and extension to install for ARM systems. When this detection doesn't work, opt-in to the Linux ARM build manually with the `APPSIGNAL_BUILD_FOR_LINUX_ARM` environment variable. Add it to your system environment before installing AppSignal and compiling your application. This environment variable is only needed if our auto detection does not detect the correct architecture. Available in these packages: * Ruby gem 3.0.8 or newer. * Elixir package 2.1.8 or newer. * Node.js package 1.2.6 or newer. Not supported in our Python package. ```sh Shell theme={null} # Set this environment variable # Note: How environment variables are set may be different for your Operating # System. export APPSIGNAL_BUILD_FOR_LINUX_ARM=1 # Run the install command, such as: bundle install, npm install, mix compile ``` ### Alpine Linux * Ruby: supports [Alpine Linux] since Ruby gem version `2.1.0`. (JRuby is not supported on Alpine Linux.) * Elixir: supports [Alpine Linux] since Elixir package version `0.11.0`. * Node.js: supports [Alpine Linux] since Node.js package version `3.0.2`. Not supported for Node.js version `14`. In AppSignal for Ruby version `2.4.0` and AppSignal for Elixir `1.4.0` we started shipping a separate build for Alpine Linux. If you upgraded from an earlier version and are have problems compiling your app, our detection isn't working properly. The following system dependencies are required for Alpine Linux: ```sh Shell theme={null} # Dependencies for the AppSignal Ruby gem apk add make gcc musl-dev musl-utils # Dependencies for the AppSignal Node.js package apk add python3 make g++ # Dependencies for the AppSignal for Elixir package version 1.7.0 and newer apk add make gcc musl-dev musl-utils # Dependencies for the AppSignal for Elixir package version 1.6.3 and older apk add make gcc musl-dev musl-utils curl ``` For all integrations, detection is based on the output from `ldd --version`. If your app is unable to call the `ldd` program or the detection is off for some reason, you can force the Alpine Linux compatible build by providing a special environment variable on install. ```sh Shell theme={null} # For Ruby export APPSIGNAL_BUILD_FOR_MUSL=1 gem install appsignal # or with Bundler bundle install # For Elixir export APPSIGNAL_BUILD_FOR_MUSL=1 mix deps.get mix compile # For Node.js export APPSIGNAL_BUILD_FOR_MUSL=1 npm install ``` #### Ruby {/* id: alpine-linux-ruby */} For the Ruby gem add this to your `Gemfile`: ```ruby Ruby theme={null} gem "appsignal", ">= 2.1.0" # or a newer version ``` For the latest available version see the full list on [RubyGems.org](https://rubygems.org/gems/appsignal/versions) and if you run into any problems please [let us know][support]. #### Elixir {/* id: alpine-linux-elixir */} If you're using the Elixir package, add this to the `deps` section your `mix.exs` file: ```elixir Elixir theme={null} {:appsignal, ">= 1.0.0"} # or a newer version ``` For the latest available version see the full list on [Hex.pm](https://hex.pm/packages/appsignal) and if you run into any problems please [let us know][support]. #### Node.js {/* id: alpine-linux-nodejs */} If you're using the Node.js package, add this to the `dependencies` section of your `package.json` file: ```text Text theme={null} "@appsignal/nodejs": "^3.0.2" ``` For the latest available version see the full list on [NPM](https://www.npmjs.com/package/@appsignal/nodejs) and if you run into any problems please [let us know][support]. ### CentOS CentOS is fully supported by the AppSignal extension. Depending on your CentOS version you may need to select another build type for AppSignal Ruby gem `v2.4.0` and AppSignal for Elixir `v1.4.0` and higher. The following system dependencies are required for CentOS: ```sh Shell theme={null} # Dependencies for the AppSignal Ruby gem and Node.js package yum install gcc gcc-c++ make openssl-devel # Dependencies for the AppSignal for Elixir package version 1.7.0 and newer yum install gcc gcc-c++ make openssl-devel # Dependencies for the AppSignal for Elixir package version 1.6.3 and older yum install gcc gcc-c++ make openssl-devel curl # Dependencies for the AppSignal for Node.js package version 2.3.4 or newer, the supported Python versions are those between Python 3.7 and Python 3.10. # Dependencies for the AppSignal for Node.js package version 2.3.3 or below, the supported Python versions are those between Python 3.5 and Python 3.8. yum install python3 ``` For CentOS 7 and higher there is no problem upgrading to AppSignal for Ruby `v2.4.0` and AppSignal for Elixir `1.4.0` and higher. For CentOS 6 and older versions you will need to opt-in to the musl build for AppSignal instead. For more information, see the [Linux section](#linux). ### Debian / Ubuntu {/* id: debian-ubuntu */} The following system dependencies are required for Debian Linux distributions: ```sh Shell theme={null} # Dependencies for the AppSignal Ruby gem and Node.js package apt-get update apt-get install build-essential ca-certificates # Dependencies for the AppSignal for Elixir package version 1.7.0 and newer apt-get update apt-get install build-essential ca-certificates # Dependencies for the AppSignal for Elixir package version 1.6.3 and older apt-get update apt-get install build-essential ca-certificates curl # Dependencies for the AppSignal for Node.js package version 2.3.4 or newer, the supported Python versions are those between Python 3.7 and Python 3.10. # Dependencies for the AppSignal for Node.js package version 2.3.3 or below, the supported Python versions are those between Python 3.5 and Python 3.8. apt-get install python3 ``` ### Fedora The following system dependencies are required for Fedora Linux distributions: ```sh Shell theme={null} # Dependencies for the AppSignal Ruby gem dnf install gcc gcc-c++ make openssl-devel # Dependencies for the AppSignal for Elixir package version 1.7.0 and newer dnf install gcc gcc-c++ make openssl-devel # Dependencies for the AppSignal for Elixir package version 1.6.3 and older dnf install gcc gcc-c++ make openssl-devel curl # Dependencies for the AppSignal for Node.js package version 2.3.4 or newer, the supported Python versions are those between Python 3.7 and Python 3.10. # Dependencies for the AppSignal for Node.js package version 2.3.3 or below, the supported Python versions are those between Python 3.5 and Python 3.8. dnf install python3 ``` ## FreeBSD Our level of FreeBSD support is currently unclear. Our tests show it works on FreeBSD 11, but we have not been able to see it report data on FreeBSD 12 and newer. Assume it will not report data on FreeBSD 12 and newer. Support for FreeBSD systems was added in AppSignal for Ruby gem `2.4.0` and AppSignal for Elixir package `1.4.0`. It currently does not support the [host metrics][host-metrics] feature. The following system dependencies are required for FreeBSD Linux distributions: ```sh Shell theme={null} pkg install gcc gmake openssl-devel # Dependencies for the AppSignal for Node.js package version 2.3.4 or newer, the supported Python versions are those between Python 3.7 and Python 3.10. # Dependencies for the AppSignal for Node.js package version 2.3.3 or below, the supported Python versions are those between Python 3.5 and Python 3.8. pkg install python3 ``` ## macOS macOS (OS X) `10.14.x` and up is supported by AppSignal for Ruby, Elixir & Node.js. It currently does not support the [host metrics][host-metrics] feature. Please make sure Xcode is installed with the command line build tools. ```sh Shell theme={null} xcode-select --install # Dependencies for the AppSignal for Node.js package version 2.3.4 or newer, the supported Python versions are those between Python 3.7 and Python 3.10. # Dependencies for the AppSignal for Node.js package version 2.3.3 or below, the supported Python versions are those between Python 3.5 and Python 3.8. brew install python@3 ``` ## Microsoft Windows We currently have no plans to support the [Microsoft Windows](https://www.microsoft.com/en-us/windows/) Operating System. We do try to make the AppSignal libraries installable on Microsoft Windows without any errors or build issues so that the app it's installed in continues to operate. If you use Microsoft Windows and would like us to support it, [send us an e-mail][support]. ### Ruby To install the AppSignal Ruby gem on Microsoft Windows, make sure you have the [RubyInstaller](https://rubyinstaller.org/) DevKit installed before installing AppSignal. Otherwise there will be the following error during installation of our C-extension. We will not install the C-extension on Microsoft Windows, but the Ruby installation detects it's part of the gem and will not continue without the DevKit. ```sh Shell theme={null} $ gem install appsignal Fetching appsignal 2.2.1 Installing appsignal 2.2.1 with native extensions Gem::InstallError: The 'appsignal' native gem requires installed build tools. Please update your PATH to include build tools or download the DevKit from 'http://rubyinstaller.org/downloads' and follow the instructions at 'http://github.com/oneclick/rubyinstaller/wiki/Development-Kit' ``` ### Microsoft Windows Subsystem for Linux We do not provide support for the Microsoft Windows Subsystem for Linux. The [Microsoft Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL) is a layer between Microsoft Windows and a [Linux](#linux) distribution. This allows users to run certain GNU/Linux distributions, that are available in the Microsoft Store, on their Microsoft Windows computer. Running an app on WSL using an AppSignal integration will not cause any errors or build issues, as described in the [Microsoft Windows section](#microsoft-windows). Running AppSignal on WSL will work as well as the WSL supports it. Follow the steps for your [Linux distribution](#linux) on this page in the WSL environment to properly install the AppSignal dependencies, before installing AppSignal in your app. In our testing using the Ubuntu WSL, we've found that most AppSignal features will work, but we can't say how accurate the information gathered from it is. Some small differences between WSL's implementation and our Linux test setups, may cause odd behavior or inaccurately reporting of metrics. We do not actively test against WSL and cannot guarantee its successful operation. We do not provide support for AppSignal on the WSL. Not all AppSignal features will work on the WSL system, in our testing we've confirmed [host metrics](/metrics/host-metrics) for disks (usage and IO) do not work. Use the WSL system to test AppSignal's integration with your app in a development environment, but not do not use this setup in a production environment. Always test your app using AppSignal on a staging environment with a similar environment (Operating System) to the app's production environment first. [alpine linux]: https://alpinelinux.org/ [musl]: https://www.musl-libc.org/ [rust]: https://www.rust-lang.org/en-US/ [host-metrics]: /metrics/host-metrics.html [support]: mailto:support@appsignal.com