Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/messaging/slim-group-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ Each member of the group must have a unique identity. This is a requirement to
setup the end-to-end encryption using the MLS protocol. The identity can be
represented by a JWT, or a shared secret. For simplicity, we will use a shared
secret. You can find examples using JWT in the [SLIM
Repo](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/common.py#L71-L112).
Repo](https://github.com/agntcy/slim/tree/slim-v0.4.0/data-plane/python-bindings/examples/src/slim_bindings_examples/common.py#L71-L112).


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

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

#### moderator.py
Expand Down Expand Up @@ -575,9 +576,9 @@ def main():
The slim repository also includes examples of 1:1 communication sessions. Using
the SLIM SDK for 1:1 sessions is very similar to the approach demonstrated in
the group communication example. For reference, see the
[fire_and_forget.py](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/fire_and_forget.py)
[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)
and
[request_reply.py](https://github.com/agntcy/slim/blob/main/data-plane/python-bindings/examples/src/slim_bindings_examples/request_reply.py)
[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)
files.

1:1 communication is particularly useful when you want to use SLIM as a
Expand Down
2 changes: 1 addition & 1 deletion docs/messaging/slim-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ def jwt_identity(

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

You can then use the provider and verifier to create a SLIM application exactly
as described in the [SLIM Group Tutorial](slim-group-tutorial.md#identity). In
Expand Down
40 changes: 37 additions & 3 deletions docs/messaging/slim-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,19 +145,53 @@ dependencies = ["slim-bindings>=0.3.6"]

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

### Slimctl

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

#### Installation

Choose the appropriate installation method for your operating system:

=== "macOS (Apple Silicon)"

```bash
curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v0.2.1/slimctl-darwin-arm64
sudo mv slimctl-darwin-arm64 /usr/local/bin/slimctl
sudo chmod +x /usr/local/bin/slimctl
```

!!! note "macOS Security"
You may need to allow the binary to run if it's blocked by Gatekeeper:

```bash
sudo xattr -rd com.apple.quarantine /usr/local/bin/slimctl
```

Alternatively, you can go to **System Settings > Privacy & Security** and allow the application to run when prompted.

=== "Linux (AMD64)"

```bash
curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v0.2.1/slimctl-linux-amd64
sudo mv slimctl-linux-amd64 /usr/local/bin/slimctl
sudo chmod +x /usr/local/bin/slimctl
```

#### Verification

After installation, verify that `slimctl` is working correctly:

```bash
curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v0.2.1/slimctl-linux-amd64
sudo mv slimctl-linux-amd64 /usr/local/bin/slimctl
slimctl help
```

This should display the help information and available commands for `slimctl`.

## Build the code

To build the project and work with the code, you need the following installed
Expand Down
4 changes: 3 additions & 1 deletion mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
Expand Down Expand Up @@ -50,7 +52,7 @@ theme:
- content.code.copy
# - content.code.select
# - content.footnote.tooltips
# - content.tabs.link
- content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
Expand Down
Loading