You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
ZeroTier Desktop Tray Application and User Interface
2
2
======
3
3
4
-
This is (as of ZeroTier 1.8) the system tray application and user interface for controlling a local ZeroTier service on Windows, Mac, and (soon) Linux systems.
4
+
This is (as of ZeroTier 1.8) the system tray application and user interface for controlling a local ZeroTier service on Windows, macOS, and (soon) Linux systems.
5
5
6
6
It runs a very tiny tray application that displays service status, network status, and allows some basic configuration operations, and then launches a system web view container when the user wishes to display a full control panel. The web view dies when this window is closed, so unlike Electron-based or other web technology based system tray apps it does not hog memory while idle.
7
7
8
8
Plumbing and tray application glue code is written in Rust. UI control panels are written using [React](https://reactjs.org) and [ElasticUI](https://elastic.github.io/eui/#/).
9
9
10
10
# Building
11
11
12
-
Only MacOS and Windows are currently supported. Linux may build but there are still outstanding issues. We're working on full Linux support at least for popular Linux desktop environments that support relatively standard tray application APIs.
12
+
Only macOS and Windows are currently supported. Linux may build but there are still outstanding issues. We're working on full Linux support at least for popular Linux desktop environments that support relatively standard tray application APIs.
13
13
14
14
Building the full HTML/JS/CSS UI bundle is a bit cumbersome but is only required if you make changes to the source code or themes under the [ui](ui/) directory. A pre-built copy of the UI is shipped in the repository to make simple builds easier and significantly faster.
15
15
16
-
## MacOS
16
+
## macOS
17
17
18
18
#### Prerequisites
19
19
@@ -23,7 +23,7 @@ Building the full HTML/JS/CSS UI bundle is a bit cumbersome but is only required
23
23
* NodeJS (we use the Node package from Homebrew)
24
24
* The [yarn](https://yarnpkg.com) package manager for NodeJS.
25
25
26
-
To build on MacOS you should just be able to type `make` from the project root. If all the necessary dependencies are present it should build a `ZeroTier.app` application in the current directory.
26
+
To build on macOS you should just be able to type `make` from the project root. If all the necessary dependencies are present it should build a `ZeroTier.app` application in the current directory.
27
27
28
28
To rebuild the UI, change into `ui/` and type `yarn install` (this is needed only once) and `yarn build`. As discussed above this is optional and is only needed if you make control panel UI changes.
29
29
@@ -37,7 +37,7 @@ To rebuild the UI, change into `ui/` and type `yarn install` (this is needed onl
37
37
38
38
To build native applications for Windows, just type `make`. This assumes that GNU make, GCC, and Cargo are in your path. The result will be two native EXEs in `target\x86_64-pc-windows-msvc\release` and `target\i686-pc-windows-msvc\release`. We plan to add native support for Windows on ARM64 soon, both for this UI application and for ZeroTier itself.
39
39
40
-
Building the web bundle part of the UI on Windows has never been done and those tool chains tend to be unfriendly to Windows. We recommend doing `yarn build` stuff in Linux or MacOS. It should work in the Linux subsystem for Windows. As mentioned above we ship this pre-built to make builds easy if you don't need to modify the JavaScript code.
40
+
Building the web bundle part of the UI on Windows has never been done and those tool chains tend to be unfriendly to Windows. We recommend doing `yarn build` stuff in Linux or macOS. It should work in the Linux subsystem for Windows. As mentioned above we ship this pre-built to make builds easy if you don't need to modify the JavaScript code.
41
41
42
42
## Linux, FreeBSD, Other Open Source Desktops
43
43
@@ -47,7 +47,7 @@ Building the web bundle part of the UI on Windows has never been done and those
47
47
48
48
The ZeroTier desktop UI uses forked and slightly modified versions of the following third party code:
49
49
50
-
*[Tray](https://github.com/zserge/tray) by [Serge Zaitsev](https://github.com/zserge), forked to slightly modify behavior in regard to loop timeouts and Mac application settings. We also manually applied a pull request that fixes builds on ARM64 MacOS. (Retains the MIT license.)
50
+
*[Tray](https://github.com/zserge/tray) by [Serge Zaitsev](https://github.com/zserge), forked to slightly modify behavior in regard to loop timeouts and Mac application settings. We also manually applied a pull request that fixes builds on ARM64 macOS. (Retains the MIT license.)
51
51
*[Rust web-view](https://github.com/Boscop/web-view) by multiple contributors, forked to modify Mac application behavior and add some custom functionality around copy/paste. (Retains the MIT license.)
52
52
53
53
Other third party dependencies are included in the normal way. See [Cargo.toml](Cargo.toml) and [ui/package.json](ui/package.json) for these.
0 commit comments