Skip to content

Commit b2ca22c

Browse files
authored
fix(slim): fixed links and slimctl installation instructions (#224)
Signed-off-by: Laszlo Gecse <lgecse@cisco.com>
1 parent e22ebb4 commit b2ca22c

4 files changed

Lines changed: 47 additions & 10 deletions

File tree

docs/messaging/slim-group-tutorial.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ Each member of the group must have a unique identity. This is a requirement to
8989
setup the end-to-end encryption using the MLS protocol. The identity can be
9090
represented by a JWT, or a shared secret. For simplicity, we will use a shared
9191
secret. You can find examples using JWT in the [SLIM
92-
Repo](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/common.py#L71-L112).
92+
Repo](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples/common.py#L71-L112).
93+
9394

9495
The python objects managing the identity are called `PyIdentityProvider` and
9596
`PyIdentityVerifier`. The `PyIdentityProvider` is responsible for providing the
@@ -292,9 +293,9 @@ script. You can run this script to see how the group communication works using
292293
SLIM.
293294

294295
The same example can be found in the [SLIM examples
295-
folder](https://github.com/agntcy/slim/tree/main/data-plane/python-bindings/examples).
296+
folder](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples).
296297
In particular this tutorial is based on the
297-
[pubsub.py](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/pubsub.py)
298+
[pubsub.py](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples/pubsub.py)
298299
example
299300

300301
#### moderator.py
@@ -575,9 +576,9 @@ def main():
575576
The slim repository also includes examples of 1:1 communication sessions. Using
576577
the SLIM SDK for 1:1 sessions is very similar to the approach demonstrated in
577578
the group communication example. For reference, see the
578-
[fire_and_forget.py](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/fire_and_forget.py)
579+
[fire_and_forget.py](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples/fire_and_forget.py)
579580
and
580-
[request_reply.py](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/request_reply.py)
581+
[request_reply.py](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples/request_reply.py)
581582
files.
582583

583584
1:1 communication is particularly useful when you want to use SLIM as a

docs/messaging/slim-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ def jwt_identity(
438438

439439
A complete example of how to use the JWT SVID in a SLIM client can be found in
440440
the examples in the [SLIM Python
441-
Bindings](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/common.py#L71-L112).
441+
Bindings](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples/common.py#L71-L112).
442442

443443
You can then use the provider and verifier to create a SLIM application exactly
444444
as described in the [SLIM Group Tutorial](slim-group-tutorial.md#identity). In

docs/messaging/slim-howto.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,19 +145,53 @@ dependencies = ["slim-bindings>=0.3.6"]
145145

146146
A tutorial on how to use the bindings in an application can be found in the [messaging layer
147147
documentation](./slim-data-plane.md). Otherwise examples are available in the
148-
[SLIM Repository](https://github.com/agntcy/slim/tree/main/data-plane/python-bindings/examples).
148+
[SLIM Repository](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples).
149149

150150
### Slimctl
151151

152152
`slimctl` is a command-line tool for managing SLIM Nodes and Controllers. It can
153153
be downloaded from the [releases
154154
page](https://github.com/agntcy/slim/releases/tag/slimctl-v0.2.1) in the SLIM repo.
155155

156+
#### Installation
157+
158+
Choose the appropriate installation method for your operating system:
159+
160+
=== "macOS (Apple Silicon)"
161+
162+
```bash
163+
curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v0.2.1/slimctl-darwin-arm64
164+
sudo mv slimctl-darwin-arm64 /usr/local/bin/slimctl
165+
sudo chmod +x /usr/local/bin/slimctl
166+
```
167+
168+
!!! note "macOS Security"
169+
You may need to allow the binary to run if it's blocked by Gatekeeper:
170+
171+
```bash
172+
sudo xattr -rd com.apple.quarantine /usr/local/bin/slimctl
173+
```
174+
175+
Alternatively, you can go to **System Settings > Privacy & Security** and allow the application to run when prompted.
176+
177+
=== "Linux (AMD64)"
178+
179+
```bash
180+
curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v0.2.1/slimctl-linux-amd64
181+
sudo mv slimctl-linux-amd64 /usr/local/bin/slimctl
182+
sudo chmod +x /usr/local/bin/slimctl
183+
```
184+
185+
#### Verification
186+
187+
After installation, verify that `slimctl` is working correctly:
188+
156189
```bash
157-
curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v0.2.1/slimctl-linux-amd64
158-
sudo mv slimctl-linux-amd64 /usr/local/bin/slimctl
190+
slimctl help
159191
```
160192

193+
This should display the help information and available commands for `slimctl`.
194+
161195
## Build the code
162196

163197
To build the project and work with the code, you need the following installed

mkdocs/mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ markdown_extensions:
1616
- admonition
1717
- pymdownx.details
1818
- pymdownx.superfences
19+
- pymdownx.tabbed:
20+
alternate_style: true
1921
- pymdownx.superfences:
2022
custom_fences:
2123
- name: mermaid
@@ -50,7 +52,7 @@ theme:
5052
- content.code.copy
5153
# - content.code.select
5254
# - content.footnote.tooltips
53-
# - content.tabs.link
55+
- content.tabs.link
5456
- content.tooltips
5557
# - header.autohide
5658
# - navigation.expand

0 commit comments

Comments
 (0)