Add documentation for using Service Desk with a relative url root
Overview
This relates to the Service Desk How-To instructions documentation: https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/service_desk_mail_room.md.
The above instructions do not work if a relative url root is configured for the gdk.
Impacted categories
The following categories relate to this issue:
- [-] gdk-reliability - e.g. When a GDK action fails to complete.
- [-] gdk-usability - e.g. Improvements or suggestions around how the GDK functions.
- [-] gdk-performance - e.g. When a GDK action is slow or times out.
Steps to replicate (optional)
- Set a relative url root (settings here: https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/configuration.md#notable-settings)
-
# in gdk.yml relative_url_root: '/gitlab'
-
- Run
gdk reconfigure
to propagate the new setting. - Configure service desk for local development: https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/service_desk_mail_room.md.
- Ensure mail room is running (
bundle exec mail_room -c ./config/mail_room.yml
). - Send an email to the service desk email address (see the how-to above for more instructions on this).
**Result: **
- Emails to mail room don't appear.
- The mail room url reported by the gem is incorrect.
- It shows:
url="http://gdk.test:3001//api/v4/internal/mail_room/incoming_email"
. - It should be:
url="http://gdk.test:3001/gitlab/api/v4/internal/mail_room/incoming_email"
.
- It shows:
Full trace:
#<struct MailRoom::Delivery::Postback::Options url="http://gdk.test:3001//api/v4/internal/mail_room/incoming_email", token=nil, username=nil, password=nil, logger=#<MailRoom::Logger::Structured:0x0000000148290128 @level=0, @progname=nil, @default_formatter=#<Logger::Formatter:0x000000014828bf10 @datetime_format=nil>, @formatter=nil, @logdev=#<Logger::LogDevice:0x000000014828bcb8 @shift_period_suffix="%Y%m%d", @shift_size=1048576, @shift_age=0, @filename="/Users/tristan/dev/ee/gitlab/log/mail_room_json.log", @dev=#<File:/Users/tristan/dev/ee/gitlab/log/mail_room_json.log>, @binmode=false, @mon_data=#<Monitor:0x000000014828bba0>, @mon_data_owner_object_id=13700>>, content_type="text/plain", jwt=#<MailRoom::JWT:0x000000011d18f038 @header="Gitlab-Mailroom-Api-Request", @secret_path="/Users/tristan/.gitlab-mailroom-secret", @issuer="gitlab-mailroom", @algorithm="HS256">>
Proposal (optional)
Add instructions of how to use mail room with a relative url root.
Edited by Tristan Read