Skip to content

Commit

Permalink
edited NC-Matrix user manual
Browse files Browse the repository at this point in the history
- changed setup for Mac
- fixed typo
  • Loading branch information
serinko authored and serinko committed Jul 10, 2023
1 parent c3ce9e2 commit 6e2eaf2
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions documentation/dev-portal/src/tutorials/matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Chat applications became an essential part of human communication. Matrix chat has end to end encryption on protocol level and Element app users can sort their communication into spaces and rooms. Now the Matrix communities can rely on network privacy as NymConnect supports Matrix chat protocol.

Currently there is no option in Matrix's Element client to set a socks5 proxy. In order to use Element via NymConnect users have to start it from the command-line. The setup is simple, for convenience a a keyboard shortcut setting can be easily done.
Currently there is no option in Matrix's Element client to set a Socks5 proxy. In order to use Element via NymConnect users have to start it from the command-line. The setup is simple, for convenience a keyboard shortcut setting or terminal alias can be easily done.


## Setup & Run
Expand Down Expand Up @@ -35,10 +35,46 @@ Alternatively you can add a keybinding via the CLI, using whatever config files
### Create an alias
If you prefer to simply shorten the length of the command (or all your keybindings are already taken) then you can simply create an alias for this long-winded command (this example aliases that command to the single word `element`, but you can replace it with whatever you like):

**Linux**

```sh
alias element="element-desktop --proxy-server=socks5://127.0.0.1:1080"
```

To make this alias persist, then add this to your `.bashrc` or `.zshrc` file (usually located in your `$HOME` directory) and `source` that file.
To make this alias persist, then add this to your `.bashrc` or `.zshrc` file (usually located in your `$HOME` directory) and `source` that file. This can be done by appending the alias command directly to the shell config file with one command.

For `bash` enter:

```sh
alias element="element-desktop --proxy-server=socks5://127.0.0.1:1080" >> ~/.bashrc
```

For `zsh` enter:

```sh
alias element="element-desktop --proxy-server=socks5://127.0.0.1:1080" >> ~/.zshrc
```

You can add the alias manually by opening your `$HOME` directory, enable hidden files (press `ctrl` + `h`) and open `.bashrc` or `.zshrc` file (based on your terminal setup) in a text editor, paste the string `alias element="element-desktop --proxy-server=socks5://127.0.0.1:1080"` to the the end, save and exit. Start a new terminal and run `element`.

**Mac**

```sh
alias element="open -a Element --args --proxy-server=socks5://127.0.0.1:1080"

```

To make this alias persist, then add this to your `.zshrc` (or `.bashrc`/`.profile`) file (usually located in your `$HOME` directory) and `source` that file. This can be done by appending the alias command directly to the shell config file with one command.

For `zsh` enter:

```sh
alias element="open -a Element --args --proxy-server=socks5://127.0.0.1:1080" >> ~/.zshrc
```

For `.bashrc` or `.profile` just change the end of the command.

You can add the alias manually by opening your `$HOME` directory, enable hidden files (in Finder press `Shift` + `Command` + `.`) and open `.zshrc` file (or `.bashrc`/`.profile`) in a text editor, paste the string `alias element="open -a Element --args --proxy-server=socks5://127.0.0.1:1080"` to the the end, save and exit. Start a new terminal and run `element`.


Now you can run Element throught the mixnet with a single-word command.
**Now you can run Element through the Nym Mixnet with a single-word command.**

0 comments on commit 6e2eaf2

Please sign in to comment.