Support for context paths

[sean-abbott]

So that you can put mailcatcher behind a reverse proxy easily. This would make it much easier to use in staging environments, or shared test environments.

[fdrouet]

that would be great !

[sj26]

Nice idea.

[Baklap4]

@sj26 How far is this away from being implemented? We'd love to have this so our containers behind traefic will work nicely again!

[andrewnicols]

I've just been hitting the same issue - would be great to see a solution to this if possible!

[liamjones]

If it's helpful for anyone else; until this is complete I've been working around it with an nginx container in my docker-compose setup that rewrites the responses using the following location config:

	location /mail {
		proxy_pass http://127.0.0.1:40130/;
		proxy_http_version 1.1;
		proxy_set_header Upgrade $http_upgrade;
		proxy_set_header Connection "upgrade";
		proxy_read_timeout 1d;
		sub_filter 'src="/'     'src="/mail/';
		sub_filter 'href="/'    'href="/mail/';
		sub_filter 'url(/'      'url(/mail/';
		sub_filter '"/messages' '"/mail/messages';
		sub_filter_types text/html text/css application/javascript;
		sub_filter_once off;
	}

[andrewnicols]

I just switched to MailHog. Just need the ProxyPass, ProxyReversePass, and a second ProxyPass for the websocket

[sj26]

I just added an --http-path option so you can add --http-path=/mailcatcher to mount mailcatcher with a path prefix of /mailcatcher for example. This has been released as 0.7.0.beta1, so you can gem install mailcatcher --pre. Give it a go?

[jgrasl]

Hi @sj26 . Awesome change. One thing seems to be not working for me tough. Every link changed to /mailcatcher except the attachment link for the mail. For me it's still goes to /messages/1/ instead of /mailcatcher/messages/1/.

[1stone]

I tried the new http-path option from 0.7.0.beta1.
When placed behind a reverse proxy, mapping /mailcatcher to localhost:1080/mailcatcher the UI and mail rendering looks fine.
However, I'm not able to "Clear" all messages. Clicking the button does show the confirmation popup, but if confirmed nothing happens.

[schmkr]

FYI, here's the error you get when pressing the "clear" button:

mailcatcher.js:formatted:6014 Uncaught TypeError: Failed to construct 'URL': Invalid URL

Coming from

mailcatcher/assets/javascripts/mailcatcher.js.coffee

Line 49 in 605e94f

url: new URL("messages")

[paulggapps]

Don't know if this helps, but we run mailcatcher on our staging servers and use a path instead of port 1080 i.e. domain.com/mc

We had everything working except attachments downloads, however, all other URLs were being correctly redirected to /mc/messages except attachment links.

Using the nginx config above by @liamjones we edited the following line and it now all works as expected:

sub_filter_types *;

[mullnerz]

Mailcatcher uses websockets, so for attachments to work, you also need to filter application/json content:

sub_filter_types text/html text/css application/javascript application/json;

(So no need for sub_filter_types *;)

[sj26]

--http-path in 0.7.0+ provides this feature.

[rajeshisnepali]

	location /mail {
		proxy_pass http://127.0.0.1:40130/;
		proxy_http_version 1.1;
		proxy_set_header Upgrade $http_upgrade;
		proxy_set_header Connection "upgrade";
		proxy_read_timeout 1d;
		sub_filter 'src="/'     'src="/mail/';
		sub_filter 'href="/'    'href="/mail/';
		sub_filter 'url(/'      'url(/mail/';
		sub_filter '"/messages' '"/mail/messages';
		sub_filter_types text/html text/css application/javascript;
		sub_filter_once off;
	}

I got an error while running in Cloudflare with brotli compression on.

root@s02:~# nginx -t                                                                                                                                                                                 
nginx: [warn] duplicate MIME type "text/html" in /etc/nginx/sites-enabled/domain.conf:33

I had a different --http-path. From google/ngx_brotli#104 (comment), I did

  location /bin {
        proxy_pass http://127.0.0.1:1081;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_read_timeout 1d;
        sub_filter '"/messages' '"/bin/messages';
        sub_filter_types text/css application/javascript;
        sub_filter_once off;
 }

and was able to run properly