Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattermost-community/mattermost-plugin-custom-attributes
Mattermost plugin for adding custom attributes to users!
https://github.com/mattermost-community/mattermost-plugin-custom-attributes
hacktoberfest mattermost mattermost-plugin
Last synced: about 18 hours ago
JSON representation
Mattermost plugin for adding custom attributes to users!
- Host: GitHub
- URL: https://github.com/mattermost-community/mattermost-plugin-custom-attributes
- Owner: mattermost-community
- License: apache-2.0
- Created: 2019-02-08T18:47:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T17:16:04.000Z (3 months ago)
- Last Synced: 2024-10-22T19:18:30.174Z (17 days ago)
- Topics: hacktoberfest, mattermost, mattermost-plugin
- Language: JavaScript
- Homepage:
- Size: 32.7 MB
- Stars: 46
- Watchers: 36
- Forks: 23
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - mattermost/mattermost-plugin-custom-attributes - Mattermost plugin for adding custom attributes to users! (hacktoberfest)
README
# Disclaimer
**This repository is community supported and not maintained by Mattermost. Mattermost disclaims liability for integrations, including Third Party Integrations and Mattermost Integrations. Integrations may be modified or discontinued at any time.**
# Mattermost Custom Attributes Plugin
[](https://circleci.com/gh/mattermost/mattermost-plugin-custom-attributes)
[](https://codecov.io/gh/mattermost/mattermost-plugin-custom-attributes)
[](https://github.com/mattermost/mattermost-plugin-custom-attributes/releases/latest)
[](https://github.com/mattermost/mattermost-plugin-custom-attributes/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)
This plugin adds custom attributes to users in your Mattermost instance. You can specify an Attribute, and then specify specific users, teams or groups which will display that attribute on their public profile - so other users can identify them easily. This can be useful when there are Team Leads, Timezones, etc. and makes it easy to show who is on a particular team or Project.
Currently the plugin only exposes the specified attributes in the user profile popover, but this plugin could be extended to allow displaying attributes elsewhere in the user interface, such as badges next to usernames. To use the "Group" features in this plugin requires a [Mattermost E20 License](https://mattermost.com/pricing/) to enable the AD/LDAP Groups Feature.
We use this plugin on https://community.mattermost.com to distinguish Mattermost core committers and staff.
## Installation
1. Go to the [releases page of this Github repository](https://github.com/mattermost-community/mattermost-plugin-custom-attributes/releases) and download the latest release for your Mattermost server.
2. Upload this file in the Mattermost System Console under **System Console > Plugins > Management** to install the plugin. To learn more about how to upload a plugin, [see the documentation](https://docs.mattermost.com/administration/plugins.html#plugin-uploads).
3. Activate the plugin at **System Console > Plugins > Management**.
## Configuration
Before you start, Identify the attributes you want to display on a user's profile popover. These can contain emojis. Some examples could be "Timezone:PST", "Development Team", "Executive Team Member", "Mentor", etc. then Identify the groups, teams or particular usernames that should display those atrributes. A spreadsheet can help to organize things.
1. Click "Add Custom Attribute" button, a text box will appear. Add the text that would appear in the user's profile popover. The text supports markdown and could include emojis and/or links, i.e. "[Integrations Team](https://developers.mattermost.com/internal/rd-teams/#integrations-team)"
2. Specify which users should have that attribute displayed on their profile. You can specify individual users, a Mattermost team name, or a Mattermost group ID (this ID needs to be copy/pasted from the group). The Mattermost group could be synched with an LDAP group to dynamically display attributes to user profiles, based on which LDAP group they currently belong to (this requires an E20 licence to enable AD/LDAP Groups).
3. Click "Save"
## Example
Here are some example rules for two users:
Their respective profile popovers display their information:
## Usage
To add a custom attribute, edit your `config.json` file and add a "CustomAttributes" field. This field contains an array of the attributes you want to add.
An attribute should have a `Name` field for what is displayed in the user interface as the attribute and an array of `UserIDs` for the users this attribute should apply to. The `Name` field can include Markdown, emojis and links.
You can fill an array of Mattermost team ID's to the `TeamIDs` parameter, and the `Name` will then be displayed
for all members of these teams.
You can also add an array of Mattermost group ID's to the `GroupIDs` parameter. The `Name` will then be displayed
for all members who are apart of that group.
Below is an example:
```
"PluginSettings": {
...
"Plugins": {
"com.mattermost.custom-attributes": {
"CustomAttributes": [
{
"Name": ":mattermost: [Core Committer](https://developers.mattermost.com/contribute/getting-started/core-committers/)",
"UserIDs": ["someuserID1", "someuserID2"],
"TeamIDs": ["someteamID1", "someteamID2"],
"GroupIDs":["somegroupID1","somegroupID2"]
},
{
"Name": ":mattermost: Staff",
"UserIDs": ["someuserID3", "someuserID4"],
"TeamIDs": ["someteamID3", "someteamID4"],
"GroupIDs":["somegroupID3","somegroupID4"]
}
]
}
}
...
"PluginStates": {
...
"com.mattermost.custom-attributes": {
"Enable": true
},
...
}
},
```
## Development
This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/integrate/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/integrate/plugins/developer-setup/) for more information about developing and extending plugins.
### Releasing new versions
The version of a plugin is determined at compile time, automatically populating a `version` field in the [plugin manifest](plugin.json):
* If the current commit matches a tag, the version will match after stripping any leading `v`, e.g. `1.3.1`.
* Otherwise, the version will combine the nearest tag with `git rev-parse --short HEAD`, e.g. `1.3.1+d06e53e1`.
* If there is no version tag, an empty version will be combined with the short hash, e.g. `0.0.0+76081421`.
To disable this behaviour, manually populate and maintain the `version` field.