Community and Support

Join the UTMStack community to get help, share detection rules and filters, and contribute to the project. This page lists where to ask questions, how to report problems and security issues, and how to contribute.

Documentation

Official documentation: user guides, installation and integration guides.
Online demo: the UTMStack v12 console with made-up sample data, no sign-in needed.
GitHub Wiki: technical articles for developers. Some articles were written for earlier versions; when they differ from this documentation, follow this documentation for UTMStack v12.

Inside UTMStack, the instance operator finds the same links in Configure > Settings > About, under Support: Documentation, GitHub repository, Report an issue and utmstack.com.

Ask the community

GitHub Discussions: questions, ideas and longer conversations, including sharing rules and filters.
Discord: chat with other users and the UTMStack team.
YouTube channel: video tutorials and walkthroughs.

Report a problem

Open an issue on GitHub Issues. This is also where Report an issue in Configure > Settings > About leads.

A good report includes:

The UTMStack version. Run this on the server:

sudo /usr/local/bin/utmstack_installer --version

The operating system and its version.
What you did, what you expected and what happened instead, with screenshots if the problem is in the web interface.

The relevant logs, with passwords, keys and personal data removed:

Problem area	Where to look
Installation	`/var/log/utmstack-installer.log`
Automatic updates	`/utmstack/updates/logs/utmstack-updater.log`
A UTMStack service	`docker service logs utmstack_<service>`, for example `docker service logs utmstack_backend`
The web server	`/var/log/nginx/error.log`

Health Checks and Troubleshooting has a script that collects these files, the service list and the server's disk, memory and time settings into one archive.

Never post /root/utmstack.yml, your connection key, API keys or licence files in a public issue. They contain secrets that give access to your server.

Report a security vulnerability

Do not report security vulnerabilities in public issues or discussions. Send them privately to [email protected], as described in the project's security policy. The Security disclosure link in Configure > Settings > About opens the repository's security page.

Contribute

We welcome contributions from the community. UTMStack is open-source software licensed under the GNU Affero General Public License version 3 (AGPL-3.0).

To contribute code or documentation:

Fork the UTMStack repository.
Clone your fork to your machine.
Create a branch for your changes.
Commit your changes to that branch and push it to your fork.
Open a pull request against the UTMStack repository.
Answer the maintainers' feedback and update your pull request as needed.

Read the full Contributing Guide before you start. The UTMStack v12 source code is on the v12 branch.

Ways to help:

Bug reports: open an issue with logs and the steps to reproduce the problem.
Feature requests: start a conversation in GitHub Discussions.
Pull requests: fix bugs, add integrations or improve the documentation.
Detection content: the correlation rules, filters, response flows, dashboards and compliance frameworks that ship with UTMStack v12 are in the definitions folder of the repository. Improvements and new rules are welcome as pull requests.

Commercial support

For guaranteed response times, implementation help, SOC architecture consulting and team training, contact UTMStack through utmstack.com.