Client setup

The following instructions would allow you to set up a Sanctuary Zero server of your own.

• Make sure that the Sanctuary Zero Server is running and is reachable.
• On another computer in the same network (applicable for both IPv6 and IPv4 options) or in a different network (applicable for a general IPv6 option or a forwarded IPv4 option), open up a terminal.
• Install python3 and pip with your GNU/Linux distribution-specific package managers.
• Install and upgrade virtualenv if not already done.

$ pip3 install virtualenv --user

• Clone the repository on your local storage and make it your current working directory.

$ git clone https://github.com/t0xic0der/sanctuary-zero.git
$ cd sanctuary-zero

• Create and activate the virtual environment.

$ virtualenv venv
$ source venv/bin/activate

• Install all dependencies for the project.

(venv) $ pip3 install -r requirements.txt

• Run the Sanctuary Zero Client with the tweakable options shown below.

(venv) $ python3 cnew.py --version
SNCTRYZERO Client by t0xic0der, version 19082020

(venv) $ python3 cnew.py --help
Usage: cnew.py [OPTIONS]

Options:
  -u, --username TEXT  Enter the username that you would identify yourself with  [required]
  -p, --password TEXT  Enter the chatroom password for decrypting the messages
  -c, --chatroom TEXT  Enter the chatroom identity you would want to enter in
  -s, --servaddr TEXT  Enter the server address you would want to connect to [required]
  --version            Show the version and exit.
  --help               Show this message and exit.

• Create a new password-protected chatroom using the following and share the chatroom identity and password for others to join.

(venv) $ python3 cnew.py -u m3x1c0 -s ws://192.168.43.194:9696/
[10:45:57] SNCTRYZERO ⮞ Starting Sanctuary ZERO v19082020 up...
[10:45:57] SNCTRYZERO ⮞ Connected to ws://192.168.43.194:9696/ successfully
[10:45:57] SNCTRYZERO ⮞ Session started at Sat Aug 22 10:45:57 2020
[10:45:57] SNCTRYZERO ⮞ A new chatroom was generated
[10:45:57] SNCTRYZERO ⮞ A new password was generated
[10:45:57] SNCTRYZERO ⮞ Chatroom identity ⮞ 37777D41
[10:45:57] SNCTRYZERO ⮞ Chatroom password ⮞ 8vEreL6GevaSm078G2rf5Mi168WX-RC_58gX_bcg6uU=
[10:45:57] SNCTRYZERO ⮞ Share the chatroom identity and password to add members!
[10:45:57] SNCTRYZERO ⮞ Your conversations are protected with end-to-end encryption
[10:45:57] USERJOINED ⮞ m3x1c0 joined - ['m3x1c0'] are connected - Indexes updated
[10:45:57] m3x1c0     ⮞

• To join a chatroom created by someone else, use the following.

(venv) $ python3 cnew.py -u m3x1c0 -p 8vEreL6GevaSm078G2rf5Mi168WX-RC_58gX_bcg6uU= -c 37777D41 -s ws://192.168.43.194:9696/
[10:51:41] SNCTRYZERO ⮞ Starting Sanctuary ZERO v19082020 up...
[10:51:41] SNCTRYZERO ⮞ Connected to ws://192.168.43.194:9696/ successfully
[10:51:41] SNCTRYZERO ⮞ Session started at Sat Aug 22 10:51:41 2020
[10:51:41] SNCTRYZERO ⮞ A valid chatroom identity was entered
[10:51:41] SNCTRYZERO ⮞ A valid chatroom password was entered
[10:51:41] SNCTRYZERO ⮞ Chatroom identity ⮞ 37777D41
[10:51:41] SNCTRYZERO ⮞ Chatroom password ⮞ 8vEreL6GevaSm078G2rf5Mi168WX-RC_58gX_bcg6uU=
[10:51:41] SNCTRYZERO ⮞ Share the chatroom identity and password to add members!
[10:51:41] SNCTRYZERO ⮞ Your conversations are protected with end-to-end encryption
[10:51:41] USERJOINED ⮞ m3x1c0 joined - ['m3x1c0'] are connected - Indexes updated
[10:51:41] m3x1c0     ⮞

• Use @username to refer to a specific username.
• Hit Ctrl+C at any point of time to exit out of the client.

[10:52:22] USERJOINED ⮞ m3x1c0 joined - ['m3x1c0'] are connected - Indexes updated
[10:52:22] m3x1c0     ⮞                                                                                                                                                                                                                                                         
[10:53:21] SNCTRYZERO ⮞ Leaving SNCTRYZERO...

• All users of a chatroom would be automatically notified about the users connecting or leaving whenever that event takes place.