Skip to content

Commit f316197

Browse files
committed
DOC: more quickstart
1 parent 76cda21 commit f316197

File tree

1 file changed

+41
-6
lines changed

1 file changed

+41
-6
lines changed

doc/quickstart.rst

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ For more details, including alternative configurations and special cases, read
88
:doc:`intro`.
99

1010

11+
.. highlight:: none
12+
1113
Preliminaries
1214
-------------
1315

16+
Instuctions below are known to work on modern GNU/Linux distributions, for
17+
example Ubuntu_.
18+
1419
First, get ``hardshare``::
1520

1621
pip install hardshare
@@ -26,15 +31,35 @@ check that you have it::
2631

2732
docker version
2833

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>`_.)
3234

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
3444
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+
3658
hardshare register
37-
hardshare check
59+
60+
61+
Start sharing!
62+
--------------
3863

3964
Start the daemon::
4065

@@ -43,3 +68,13 @@ Start the daemon::
4368
Check it::
4469

4570
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

Comments
 (0)