github-desktop/docs/contributing/setup-linux.md

46 lines
1.3 KiB
Markdown
Raw Normal View History

2018-11-21 14:43:43 +00:00
# Setting Up Development Dependencies on Linux
2018-11-22 15:28:55 +00:00
You will need to install these tools on your machine:
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
- Node.js v8.12.0 (also ensure you can build native modules)
- Python 2.7
- Electron dependencies
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
## Node.js
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
The GitHub Desktop toolchain currently requires Node 8.x currently, and the
NodeJS project has instructions for installing across a variety of
distributions and package managers.
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
Find your distribution on [this list](https://nodejs.org/en/download/package-manager/)
and follow the instructions to install the version you require.
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
## Python 2
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
Refer to your distributions package manager to obtain the latest version of the
Python 2 series.
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
## Electron dependencies
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
There are some additional dependencies which are required as part of building
and running GitHub Desktop locally:
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
- `libsecret-1.so.0` for reading and writing credentials using [`keytar`](https://github.com/atom/node-keytar)
- `libXss.so.1` - the library for the X11 screen saver extension
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
Where to find these will vary based on your distribution, but below are some
examples of distributions we've tested.
2018-11-21 14:43:43 +00:00
2018-11-22 15:28:55 +00:00
### Fedora 26 and later
2018-11-21 14:43:43 +00:00
```shellsession
2018-11-22 15:28:55 +00:00
$ sudo dnf install -y libsecret-devel libXScrnSaver
2018-11-21 14:43:43 +00:00
```
2018-11-22 15:28:55 +00:00
### Ubuntu 14.04 and later
2018-11-21 14:43:43 +00:00
```shellsession
2018-11-22 15:28:55 +00:00
$ sudo apt install libsecret-1-dev
2018-11-21 14:43:43 +00:00
```