self-hosted/optional-modifications
Hubert Deng 019d372df2
Revert "fix(vroom): Explicitly set PROFILES_DIR for upcoming change" (#3760)
* Revert "fix(vroom): Explicitly set PROFILES_DIR for upcoming change (#3759)"

This reverts commit e07445d6be41793165316a3e077ebec343740530.

It also very importantly changes where we mount the profiles volume which fixes the issue. Our theory is as follows:

1. Vroom Dockerfile had a line doing `mkdirp /var/lib/sentry-profiles` at image build time. This makes the directory owned by `root`
2. When we mount over that directory, and change permissions we can store the permissions changes _in_ the directory but not the directory itself
3. So when we start the vroom image with the new mount, the contents are owned by `vroom` but the main directory is still owned by `root`. This is also why [this approach](a23a4e3952) worked as the entrypoint script did this at the start of every container instance.

---------

Co-authored-by: Burak Yigit Kaya <byk@sentry.io>
2025-06-17 21:26:01 +01:00
..

Optional Modifications

Other than the default self-hosted Sentry installation, sometimes users can leverage their existing infrastructure to help them with limited resources. "Patches", or you might call this like a "plugin system", is a collection of patch files (see man patch(1)) that can be used with to modify the existing configuration to achieve the desired goal.

Warning

Beware that this is very experimental and might not work as expected.

Use it at your own risk!

How to use patches

The patches are designed mostly to help modify the existing configuration files. You will need to run the install.sh script afterwards.

They should be run from the root directory. For example, the external-kafka patches should be run as:

patch < optional-modifications/patches/external-kafka/.env.patch
patch < optional-modifications/patches/external-kafka/config.example.yml.patch
patch < optional-modifications/patches/external-kafka/sentry.conf.example.py.patch
patch < optional-modifications/patches/external-kafka/docker-compose.yml.patch

Some patches might require additional steps to be taken, like providing credentials or additional TLS certificates.

Official support

Sentry employees are not obliged to provide dedicated support for patches, but they can help by providing information to move us forward. We encourage the community to contribute for any bug fixes or improvements.

See the support policy for self-hosted Sentry for more information.