111 lines
3.1 KiB
Markdown
111 lines
3.1 KiB
Markdown
# Getting Started with JAMA
|
|
|
|
Welcome to **JAMA** — your private, self-hosted team messaging app.
|
|
|
|
---
|
|
|
|
## Navigating JAMA
|
|
|
|
### PRIVACY ASSURED
|
|
The only people that can read your direct messages (person 2 person or group) are the members of the message group. No one else, including admins, know which message groups exist or which you are part of, unless an they are a member of a given group that you are.
|
|
|
|
Every user can, at minimum, read all public messages.
|
|
|
|
---
|
|
|
|
### 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
|
|
- **Lock** icon indicates a **Private** group — invite only
|
|
- **Bold** group names have unread messages
|
|
- The last message preview shows **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 **@** followed by the person's name to mention them. Select from the dropdown that appears. Mentioned users receive a notification.
|
|
|
|
Example: `@[John Smith]` will notify John.
|
|
|
|
### Replying to a Message
|
|
Hover over any message and click the **reply arrow** to quote and reply to it.
|
|
|
|
### Reacting to a Message
|
|
Hover over any message and click the **emoji** button to react with an emoji.
|
|
|
|
---
|
|
|
|
## Direct Messages
|
|
|
|
Two ways to start a private conversation with one person:
|
|
|
|
1. Click the **New Chat** icon in the sidebar
|
|
2. Select one user from the list
|
|
3. Click **Start Conversation**
|
|
4. Click the users avatar in a message to bring up the profile
|
|
5. Click **Direct Message**
|
|
|
|
---
|
|
|
|
## 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 group with the exact same members already exists, you will be redirected to it automatically to help avoid duplication.
|
|
|
|
---
|
|
|
|
## 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**
|
|
- 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.
|
|
|
|
---
|
|
|
|
## Settings
|
|
|
|
Admins can access **Settings** from the user menu to configure:
|
|
|
|
- Branding a new app name and logo
|
|
- Set new user password
|
|
- Notification preferences
|
|
|
|
---
|
|
|
|
## 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
|