electron/docs/tutorial/support.md

79 lines
2.9 KiB
Markdown
Raw Normal View History

2018-04-30 22:16:15 +00:00
# Electron Support
2018-04-30 22:58:19 +00:00
## Finding Support
If you have a security concern,
2018-04-30 23:11:10 +00:00
please see the [security document](../../SECURITY.md).
2018-04-30 22:58:19 +00:00
If you need programming help,
or want to join in the discussion with other Electron developers,
or want to find sample starter applications,
see [these community resources](../../README.md#community).
If you'd like to contribute to Electron,
2018-04-30 23:11:10 +00:00
see the [contributing document](../../CONTRIBUTING.md).
If you've found a bug in a [supported version](#supported-versions) of Electron,
please report it with the [issue tracker](../development/issues.md).
2018-04-30 22:58:19 +00:00
2018-04-30 22:16:15 +00:00
## Supported Versions
2018-04-30 23:11:10 +00:00
The latest three release branches are supported by the Electron team.
2018-04-30 22:16:15 +00:00
For example, if the latest release is 2.0.x, then the 2-0-x series
is supported, as are the two previous release series 1-7-x and 1-8-x.
2018-04-30 22:17:42 +00:00
When a release branch reaches the end of its support cycle, the series
will be deprecated in NPM and a final end-of-support release will be
made. This release will add a warning to inform that an unsupported
version of Electron is in use.
These steps are to help app developers learn when a branch they're
using becomes unsupported, but without being excessively intrusive
to end users.
2018-04-30 22:16:15 +00:00
If an application has exceptional circumstances and needs to stay
on an unsupported series of Electron, developers can silence the
end-of-support warning by omitting the final release from the app's
`package.json` `devDependencies`. For example, since the 1-6-x series
ended with an end-of-support 1.6.18 release, developers could choose
2018-04-30 22:58:19 +00:00
to stay in the 1-6-x series without warnings with `devDependency` of
2018-04-30 22:16:15 +00:00
`"electron": 1.6.0 - 1.6.17`.
## Supported Platforms
2015-10-03 05:42:34 +00:00
Following platforms are supported by Electron:
2016-06-18 13:26:26 +00:00
### macOS
2015-10-03 05:42:34 +00:00
2016-06-18 13:26:26 +00:00
Only 64bit binaries are provided for macOS, and the minimum macOS version
supported is macOS 10.9.
2015-10-03 05:42:34 +00:00
### Windows
Windows 7 and later are supported, older operating systems are not supported
(and do not work).
2015-10-03 05:42:34 +00:00
Both `ia32` (`x86`) and `x64` (`amd64`) binaries are provided for Windows.
Please note, the `ARM` version of Windows is not supported for now.
2015-10-03 05:42:34 +00:00
### Linux
The prebuilt `ia32` (`i686`) and `x64` (`amd64`) binaries of Electron are built on
Ubuntu 12.04, the `armv7l` binary is built against ARM v7 with hard-float ABI and
NEON for Debian Wheezy.
2015-10-03 05:42:34 +00:00
[Until the release of Electron 2.0][arm-breaking-change], Electron will also
continue to release the `armv7l` binary with a simple `arm` suffix. Both binaries
are identical.
Whether the prebuilt binary can run on a distribution depends on whether the
distribution includes the libraries that Electron is linked to on the building
platform, so only Ubuntu 12.04 is guaranteed to work, but following platforms
are also verified to be able to run the prebuilt binaries of Electron:
2015-10-03 05:42:34 +00:00
2018-04-30 22:16:15 +00:00
* Ubuntu 12.04 and newer
2015-10-03 05:42:34 +00:00
* Fedora 21
* Debian 8
[arm-breaking-change]: https://github.com/electron/electron/blob/master/docs/tutorial/planned-breaking-changes.md#duplicate-arm-assets