# Getting Started with JAMA

Welcome to **JAMA** — your private, self-hosted team messaging app.

**JAMA** - **J**ust **A**nother **M**essaging **A**pp

---

## What is JAMA?

JAMA is a private chat system that doesn’t need the internet to work—you can host it on a completely offline network. Even if you do run JAMA while you're online, it stays locked inside its own "container," so it never reaches out to other internet services. 

We keep things private, too: the only info we ask for is a name and an email, and technically speaking they don't even have to be real. Your name just helps your team know who you are, and your email is only used as your login (it's never shares with anyone else).

There’s no annoying phone or email verification to deal with, so you can jump right in. If you ever get locked out, just hit the "Get Help" link on the login page. JAMA is easy and intuitive, you're going to love it.

----
----

## Security

### 🛡️ Your Privacy Assured
**Encryption**, the JAMA database is fully encrypted. Your posts are protected from prying eyes, including the JAMA administrators. 

The only people that can read your direct messages (**person 2 person** or **group**) are the members of your message group. No one else knows, including JAMA admins, which direct message groups exist or which you are part of, well, unless they are a member of the group. With the database being encrypted there is no easy way to access your data.

**Every user**, at minimum, can read all public messages.

----
----

## Navigating JAMA

### Message List (Left Sidebar)
The sidebar shows all your message groups and direct conversations. Tap or click any group to open it.

- **#** prefix indicates a **Public** group — visible to all users
- **Bold** group names, with a notification badge means you have unread messages
- A message with the newest post with alway be listed at the top
- The last message preview shows a message from a user in your group, or **You:** if you sent it


## Sending Messages

Type your message in the input box at the bottom and press **Enter** to send.

- **Shift + Enter** adds a new line without sending
- Tap the **+** button to attach a photo or emoji
- Use the **camera** icon to take a photo directly (mobile only)

### Mentioning Someone
Type **@** will bring a group user list, select a users real name to mention them. Users receive a notification.

Example: `@[John Smith]` will notify John Smith of the message.

### Replying to a Message
Hover over any message and click the **reply arrow** in the pop-up to quote and reply to it.

### Reacting to a Message
Hover over any message and select a common emoji in the pop-up to or click the **emoji** button to bring up a full list to select from.

---

## Direct Messages

There are two ways to start a private conversation with one person:

_**New Chat Button**_
1. Click the **New Chat** icon in the sidebar
2. Select one user from the list
3. Click **Start Conversation**

_**Message Window**_
1. Click the users avatar in a message window to bring up the profile
2. Click **Direct Message**

> _Users have the ability to disable direct and private messages in their profile. If set, they will not be listed in the "New Chat" user list and the "Direct Message" button is not enabled._

---

## Group Messages

To create a group conversation:

1. Click the **new chat** icon
2. Select two or more users from the 
3. Enter a **Message Name**
4. Click **Create**

> _If a message group with the exact same members already exists, you will be redirected to it automatically. This helps to avoid duplication._

_**Note:** Users have the option to leave any direct message group by selecting the "Message Info" button in the top right corner in the message title._

---

## Your Profile

Click your name or avatar at the bottom of the sidebar to:

- Update your **display name** (displayed in message windows)
- Add an **about me** note
- Upload a **profile photo** for your avatar
- Change your **password**

---

## Customising Group Names

You can set a personal display name for any group that only you will see:

1. Open the message
2. Click the **message info** icon in the top right
3. Enter your custom name under **Your custom name**
4. Click **Save**

Other members still see the original group name, unless they change to customised name for themselves.

---

## Admin Options

Admins can access **Settings** from the user menu to configure:

- **Branding:** a new app name and/or logo, title colour and message list avatar background colours
- **User Manager:** Create new user password, change passwords, suspend and delete user accounts.
- **Settings:** Various options

---

## Tips

- 🌙 Toggle **dark mode** from the user menu
- 🔔 Enable **push notifications** when prompted to receive alerts when the app is closed
- 📱 Install JAMA as a **PWA** on your device — tap *Add to Home Screen* in your browser menu for an app-like experience
