@@ -8,9 +8,14 @@ For more details, including alternative configurations and special cases, read
8
8
:doc: `intro `.
9
9
10
10
11
+ .. highlight :: none
12
+
11
13
Preliminaries
12
14
-------------
13
15
16
+ Instuctions below are known to work on modern GNU/Linux distributions, for
17
+ example Ubuntu _.
18
+
14
19
First, get ``hardshare ``::
15
20
16
21
pip install hardshare
@@ -26,15 +31,35 @@ check that you have it::
26
31
27
32
docker version
28
33
29
- Create an `API token <https://rerobots.net/tokens >`_ for your hardshare client
30
- to use. (Learn how to do this `from the rerobots Web Guide
31
- <https://help.rerobots.net/webui.html#making-and-revoking-api-tokens> `_.)
32
34
33
- * hardshare config -c
35
+ Create local configuration
36
+ --------------------------
37
+
38
+ Get an `API token <https://rerobots.net/tokens >`_ to associate with your
39
+ hardshare client. (Learn how to do this `from the rerobots Web Guide
40
+ <https://help.rerobots.net/webui.html#making-and-revoking-api-tokens> `_.) Then,
41
+ initialize a new local configuration, and add the API token to it::
42
+
43
+ hardshare config -c
34
44
hardshare config --add-key path/to/your/jwt.txt
35
- hardshare config --add-ssh-path path/to/your/ssh_key (e.g., ~/.ssh/id_rsa)
45
+
46
+ Next, add an SSH key pair for the hardshare client to create tunnels. There
47
+ might already be one at ``~/.ssh/id_rsa ``. If not, or if you want to create a
48
+ new pair for this purpose, then::
49
+
50
+ ssh-keygen
51
+
52
+ Add the SSH secret key path::
53
+
54
+ hardshare config --add-ssh-path path/to/your/ssh_key
55
+
56
+ Finally, create a new workspace deployment::
57
+
36
58
hardshare register
37
- hardshare check
59
+
60
+
61
+ Start sharing!
62
+ --------------
38
63
39
64
Start the daemon::
40
65
@@ -43,3 +68,13 @@ Start the daemon::
43
68
Check it::
44
69
45
70
hardshare status
71
+
72
+ which should result in output that is similar to the following::
73
+
74
+ - daemon_found: true
75
+ has_instance: false
76
+ provider: docker
77
+ wdeployment: b47cd57c-833b-47c1-964d-79e5e6f00dba
78
+
79
+
80
+ .. _Ubuntu : https://ubuntu.com/download/desktop
0 commit comments