Skip to content

Installation

These instructions cover installing and running Enclave Messenger on your system. Adjust paths and commands for your environment.

Requirements

  • Python 3.10+ (or your minimum supported version)
  • pip and a working virtualenv setup (recommended)
  • For Bluetooth plugin: working Bluetooth stack and permissions
  • For SMS gateway plugin: appropriate hardware/gateway access

Run The Initial Setup Stuff

On Linux/MacOS

Run:

curl -sL https://raw.githubusercontent.com/Project-Enclave/setup/main/messenger.sh -o /tmp/enclave-setup.sh && bash /tmp/enclave-setup.sh

A photo of a shell installing messenger by project enclave

On Windows...

Note that this has NEVER been tested on Windows because I(Chinglen2080 aka Pradhya) do NOT have a windows system/install.

Powershell

Run: '''cmd irm https://raw.githubusercontent.com/Project-Enclave/setup/main/messenger.ps1 -OutFile $env:TEMPenclave-setup.ps1; & $env:TEMPenclave-setup.ps1


#### Command Prompt

Run:
```cmdp
curl -sL https://raw.githubusercontent.com/Project-Enclave/setup/main/messenger.bat -o %TEMP%enclave-setup.bat
%TEMP%enclave-setup.bat

The Setup Process

The setup script will print a lot of stuff, you can ignore that if you want. But there will be stuff that you have to fill like your posts, name, passphrase, etc

A photo of Pradhya going through the setup

Run Enclave

TUI

python tui.py

TUI where it hasnt been unlocked and is empty

Fill your password so it looks like this-

TUI where it hasnt been unlocked and is not empty

Note: DO NOT USE A SHORT/INSECURE PASSWORD! PLEASE!

If you got it correct, then you'll see this!

TUI Home

Web UI

python web.py

The shell will look like this-

A photo of web.py running right after set.py is done

When you go to the link given, you'll see this,

The login modal on localhost

Fill it up!

The login modal on localhost, but filled!

Tada! You've made it to the home screen!

The home for the web UI on localhost

You can (and you should) set up other stuff via the web UI in the settings modal like display name and make new profiles to seperate stuff or to test the messenger out!

The setting modal in the profile section

The long string is just your client id (Aka enclave id)

Then open the displayed URL (typically http://localhost:<port>) in a browser.

First-run flow

On first run, Enclave will:

  1. Prompt for a profile name.
  2. Ask for a passkey (used to protect local keys).
  3. Create initial configuration and key files under the profile directory.

Screenshots of this flow are available in the Project-Enclave/assets repository. Ill add how to test the messenger on the same device on a different file.