Skip to content

Commit eb8ad41

Browse files
authored
Adding tabs to bee-clef to have mac specific info (#157)
1 parent f35cce0 commit eb8ad41

File tree

1 file changed

+43
-5
lines changed

1 file changed

+43
-5
lines changed

docs/installation/bee-clef.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: Clef External Signer
33
id: bee-clef
44
---
55

6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
69
Bee makes use of Go Ethereum's external signer, [Clef](https://geth.ethereum.org/docs/clef/tutorial).
710

811
Because Bee must sign a lot of transactions automatically and quickly, a [Bee specific version of Clef, Bee-clef](https://github.com/ethersphere/bee-clef) has been packaged which includes all the relevant configuration and implements the specific configuration needed to make Clef work with Bee.
@@ -15,7 +18,17 @@ Clef will create a new Ethereum key pair for you during installation. Make sure
1518

1619
Bee clef can be installed automatically using your system's package manager.
1720

18-
### Ubuntu / Raspbian / Debian
21+
22+
23+
24+
<Tabs
25+
defaultValue="debian"
26+
values={[
27+
{label: 'Ubuntu / Debian / Raspbian', value: 'debian'},
28+
{label: 'CentOS', value: 'centos'},
29+
{label: 'MacOS', value: 'macos'},
30+
]}>
31+
<TabItem value="debian">
1932

2033
#### AMD64
2134

@@ -40,7 +53,8 @@ wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0
4053
sudo dpkg -i bee-clef_0.4.9_arm64.deb
4154
```
4255

43-
### CentOS
56+
</TabItem>
57+
<TabItem value="centos">
4458

4559
#### AMD64
4660

@@ -65,13 +79,18 @@ wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0
6579
sudo rpm -i bee-clef_0.4.9_arm64.rpm
6680
```
6781

68-
### MacOS
82+
</TabItem>
83+
<TabItem value="macos">
6984

7085
```bash
7186
brew tap ethersphere/tap
7287
brew install swarm-clef
7388
```
7489

90+
</TabItem>
91+
</Tabs>
92+
93+
7594
To run Bee Clef as a service now and on startup, run:
7695

7796
```bash
@@ -85,9 +104,18 @@ Under a normal/default package install, there wont be any configuration changes
85104

86105
### Interact With Clef
87106

88-
Once Clef has been installed, it will begin running as a service using `systemd`.
107+
Once Clef has been installed, it will begin running as a service.
108+
109+
To check Clef is running ok, we may use `systemctl` (on Linux) or `launchctl` (on MacOS) to query the status of the `bee-clef` service.
89110

90-
To check Clef is running ok, we may use `systemctl` to query the status of the `bee-clef` service.
111+
112+
<Tabs
113+
defaultValue="linux"
114+
values={[
115+
{label: 'Linux', value: 'linux'},
116+
{label: 'MacOS', value: 'macos'},
117+
]}>
118+
<TabItem value="linux">
91119

92120
```bash
93121
systemctl status bee-clef
@@ -104,6 +132,16 @@ And if you want to follow it's logs, you can use:
104132
journalctl -f -u bee-clef.service
105133
```
106134

135+
</TabItem>
136+
<TabItem value="macos">
137+
138+
```bash
139+
launchctl list | grep swarm-clef
140+
```
141+
142+
</TabItem>
143+
</Tabs>
144+
107145
When Bee-clef first starts, you should see something very similar to the following:
108146
```log
109147
Feb 21 19:52:43 comp-name systemd[1]: Started Bee Clef.

0 commit comments

Comments
 (0)