Commit 7e485f4f authored by Thibaut Sardan's avatar Thibaut Sardan Committed by Luke Schoen
Browse files

Move unessential content to the wiki (#471)

parent 93d7cfcb
Pipeline #33416 passed with stages
in 8 minutes and 57 seconds
......@@ -17,7 +17,9 @@ Parity Fether connects to the light node using [`@parity/light.js`](https://gith
Parity Fether is licensed under the BSD 3-Clause, and can be used for all your Ethereum needs.
If you run into problems while using Parity Fether, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/fether) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](https://github.com/paritytech/parity/blob/master/SECURITY.md).
If you run into problems while using Parity Fether, first check out the [FAQ](https://wiki.parity.io/Fether-FAQ) on our wiki and feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/fether) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat rooms if you have any question. We are glad to help!
**For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](https://github.com/paritytech/parity/blob/master/SECURITY.md).
---
......@@ -33,7 +35,7 @@ Get in touch with us on Gitter:
Official website: https://parity.io | Be sure to check out [our Wiki](https://wiki.parity.io) for more information.
## Install and start Parity Fether
## Install and start Parity Fether using binaries
### Mac
- Download the [`.dmg` file](https://github.com/paritytech/fether/releases).
......@@ -60,33 +62,6 @@ Official website: https://parity.io | Be sure to check out [our Wiki](https://wi
- Download the [`.deb` file](https://github.com/paritytech/fether/releases).
- Double click on the file to install Fether.
- Fether will be added to the program menu.
### Passing config flags to the underlying Parity Ethereum node
You can pass specific flags for fether to launch the underlying Parity Ethereum with:
```bash
# Launching Parity Ethereum light client on Ropsten instead of Kovan (default) and connect Fether to it
$ /path/to/fether --chain ropsten --light
```
### Separately launch Parity Ethereum node
You can also launch Parity Ethereum node before, with any flag you want:
```bash
# Launching Parity Ethereum light client on Ropsten instead of Kovan (default)
$ parity --chain ropsten --light
```
In another console launch Fether:
```bash
# Fether will connect to the running node
$ /path/to/fether
```
## Build from sources
......@@ -156,17 +131,6 @@ yarn package
yarn start
```
### Run without taskbar mode (no tray icon)
```bash
TASKBAR=false yarn start
```
> Troubleshooting: If it hangs on a white screen in Electron even though it has compiled and has been syncing for a long time, then simply choose 'View > Reload' (CMD + R on Mac, CTRL + R on Linux/Windows) from the Fether/Electron menu.
> Developer Tools: Open developer tools automatically by running `DEBUG=true yarn start` when not in the production environment.
## Build binaries for production
### General Notes:
......@@ -215,77 +179,3 @@ rm -rf /packages/fether-electron/dist;
yarn; yarn build; DEBUG=electron-builder yarn release --win;
./packages/fether-electron/dist/Parity\ Fether-0.3.0.exe
```
## Debugging in production
Show terminal logs whilst running a binary executable.
### Mac
```
tail -f ~/Library/Application\ Support/fether/fether.log
```
### Linux
```
tail -f ~/.config/fether/fether.log
```
### Windows
```
tail -f ~/Application\ Data/fether/fether.log
```
## Usage of taskbar mode
### Mac
Taskbar mode is `true` by default.
* Enabled `true`
* Tray icon - Left-click or right-click the tray icon shows "tray context menu" containing just "Show/Hide Fether" and "Quit" options. "Show/Hide Fether" toggles the Fether window show/hide
* Dock icon - no action
* Fether window - frameless
* Disabled `false`
* Dock icon - toggles show/hide Fether window
* Fether window - frame (with close/minimise icons)
* Always
* Menubar - Fether menu shown by default
* Fether window - "window context menu" shown upon right-click in the Fether window
* Fether window - position is saved upon move, minimising, and close so it is restored in the same position.
### Linux
Taskbar mode is `true` by default.
* Enabled `true`
* Tray icon - Left-click or right-click the tray icon shows "tray context menu" containing just "Show/Hide Fether" and "Quit" options. "Show/Hide Fether" toggles the Fether window show/hide
* Dock icon - toggles show/hide Fether window
* Fether window - frameless
* Disabled `false`
* Dock icon - toggles show/hide Fether window
* Fether window - frame (with close/minimise icons)
* Menubar - Fether menu may not be shown in the tray by default depending on whether `setMenuBarVisibility` has been set. Fether menu may be configured to automatically hide by setting `setAutoHideMenuBar`. Toggle show/hide the Fether menu in the frame by clicking the Fether window and then holding down the ALT key to reveal it, which only works if auto-hide menu bar is enabled.
* Always
* Fether window - "window context menu" shown upon right-click in the Fether window
* Fether window - position is saved upon move, minimising, and close so it is restored in the same position.
### Windows
Taskbar mode is `true` by default.
* Enabled `true`
* Tray icon - Left-click toggles show/hide Fether window
* Tray icon - Right-click the tray icon shows "tray context menu" containing just "Show/Hide Fether" and "Quit" options. "Show/Hide Fether" toggles the Fether window show/hide
* Dock icon - toggles show/hide Fether window
* Fether window - frameless
* Disabled `false`
* Dock icon - toggles show/hide Fether window
* Fether window - frame (with close/minimise icons).
* Menubar - Fether menu may not be not shown in the tray by default depending on whether `setMenuBarVisibility` has been set. Fether menu may be configured to automatically hide by setting `setAutoHideMenuBar`. Toggle show/hide the Fether menu in the frame by clicking the Fether window and then holding down the ALT key to reveal it, which only works if auto-hide menu bar is enabled.
* Always
* Fether window - "window context menu" shown upon right-click in the Fether window
* Fether window - position is saved upon move, minimising, and close so it is restored in the same position.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment