240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
61 lines
3.5 KiB
Plaintext
61 lines
3.5 KiB
Plaintext
---
|
|
title: "Customizing Mattermost"
|
|
---
|
|
<PlanAvailability slug="all-commercial" />
|
|
|
|
There are several ways to customize your Mattermost server.
|
|
|
|
If customizing Mattermost, please avoid branding that could be confused with the Mattermost brand. For example, it's okay to brand as "Healthcare Central" because it's a completely different brand. "Mattermost Healthcare Central" is not okay, because it can potentially be confused with the Mattermost brand. Please see the [Mattermost trademark guidelines](https://mattermost.com/trademark-standards-of-use/) for details.
|
|
|
|
While you're welcome to add your own copyright notice in the user interface if you feel it is warranted by your changes, we ask that you do not remove the Mattermost, Inc. copyright notice from the login footer or from the About dialog.
|
|
|
|
## Mattermost Web App
|
|
|
|
The Mattermost webapp is licensed under the Apache 2.0 license. To modify and use with the Mattermost server, you can:
|
|
|
|
1. Install the Mattermost server by following one of our installation guides
|
|
2. Fork the [mattermost](https://github.com/mattermost/mattermost) repository
|
|
3. Go to the web app code located in the `webapp` directory and make your changes
|
|
4. Run `make package` to create `mattermost-webapp.tar.gz`
|
|
5. Copy `mattermost-webapp-tar.gz` to the location Mattermost was installed in Step 1
|
|
6. Rename the existing `client` folder to `client-original`
|
|
7. Run `tar -xvf mattermost-webapp.tar.gz` to extract your new customized `client` folder
|
|
8. If you're installing Mattermost 7.5 - 7.10, copy the `products` folder from `client-original` into `client`
|
|
9. Restart your Mattermost server
|
|
|
|
It is possible to customize certain parts of the webapp without forking by using our [Custom Branding](/administration-guide/configure/custom-branding-tools) settings.
|
|
|
|
To replace the logo in email notifications, change the file located in the `/images` directory. To change the app icon, modify the `/app/components/app_icon.js` file.
|
|
|
|
## Mattermost Server
|
|
|
|
There are a few things you can customize in the Mattermost server without forking:
|
|
|
|
1. Modify text in the Mattermost interface by modifying the `en.json` file.
|
|
2. Customize or hide help and support links by modifying your [configuration settings](/administration-guide/configure/site-configuration-settings#customization).
|
|
3. Customize the email notifications by editing the HTML files in `/templates`. From Mattermost v11.3.0, changes to HTML templates require a server restart to take effect.
|
|
|
|
## Mattermost mobile apps
|
|
|
|
The Mattermost mobile apps can be customized if you choose to build the apps yourself.
|
|
|
|
To brand the mobile apps:
|
|
|
|
1. Fork the [mattermost-mobile](https://github.com/mattermost/mattermost-mobile) repository.
|
|
2. Replace the name, images, and any key text strings.
|
|
3. Compile the custom apps.
|
|
4. Deploy the apps to an app store.
|
|
|
|
While most organizations deploy to internal enterprise app stores, you are welcome to deploy to iTunes and Google Play as long as the branding is not confusable with official Mattermost products.
|
|
|
|
## Mattermost desktop apps
|
|
|
|
The Mattermost desktop apps can be customized if you choose to build the apps yourself.
|
|
|
|
To brand the desktop apps:
|
|
|
|
1. Fork the [mattermost/desktop](https://github.com/mattermost/desktop) repository
|
|
2. Replace the name, images, and any key text strings
|
|
3. Refer to [the Mattermost Developer documentation](https://developers.mattermost.com/contribute/more-info/desktop/) for help with compiling the apps
|
|
4. Share the desktop application with your users
|