Auto SSL with Snaps

We now include the option to enable Caddy in your snap. Caddy makes use of Let's Encrypt to automatically provide you TLS protection for your communications.
Starting from release 0.73 you can easily configure everything related to Caddy using snap hooks to ensure your DNS configuration is set up correctly before starting Caddy and Let's Encrypt support.
Configure everything using snap
For 4.x latest AMD64 snaps or 3.x latest ARM64 snaps
Set the SiteUrl to your domain, make sure it is prefixed with https.
sudo snap set rocketchat-server siteurl=https://<your domain>
Now start Caddy and restart the snap services.
sudo systemctl enable --now snap.rocketchat-server.rocketchat-caddy 
sudo snap restart rocketchat-server
For older snaps
If you want to enable TLS and Let's Encrypt certificates you should:
1.Input a URL starting with HTTPS
2.Own the domain name you would like to use
3.Have the correct DNS record set up to resolve your domain name to your public IP (remember DNS records could take some time to propagate).
These next commands will check that configuration is set up correctly before starting the services:
sudo snap set rocketchat-server caddy-url=https://<your-domain-name>
sudo snap set rocketchat-server caddy=enable
sudo snap set rocketchat-server https=enable
sudo snap run rocketchat-server.initcaddy
If no errors were found, it is safe to restart Rocket.Chat and Caddy:
sudo systemctl restart snap.rocketchat-server.rocketchat-server.service
sudo systemctl restart snap.rocketchat-server.rocketchat-caddy.service
In case you don't want to configure TLS for your site, or want to remove TLS configuration:
sudo snap set rocketchat-server https=disable
sudo snap set rocketchat-server caddy-url=http://<your-domain-name>
sudo snap set rocketchat-server caddy=enable
sudo snap run rocketchat-server.initcaddy
If no errors were found, it is safe to restart Rocket.Chat and Caddy:
sudo systemctl restart snap.rocketchat-server.rocketchat-server.service
sudo systemctl restart snap.rocketchat-server.rocketchat-caddy.service
Check Caddy's logs
sudo snap logs -f rocketchat-server.rocketchat-caddy
Configure Caddy yourself or use another HTTP Proxy
For 4.x latest AMD64 snaps or 3.x latest ARM64 snaps
Both caddy v2 and caddy v1 (EOL) is delivered in the snap, v2 is prioritized over v1.
If you want to configure Caddy yourself, place the Caddyfile in /var/snap/rocketchat-server/current/ directory and restart rocketchat-server.
sudo snap restart rocketchat-server
If you want to use some other reverse proxy, just disable Caddy by running.
sudo systemctl disable snap.rocketchat-server.rocketchat-caddy
For older versions
In case you plan to use another https proxy or you prefer other options in Caddy configuration, you can disable caddy:
sudo snap set rocketchat-server caddy=disable
Then, edit the Caddyfile found at /var/snap/rocketchat-server/current/Caddyfile and write your configuration.
Replace _caddy-url_ and _port_ with your site information. For instance, let's say I have example-domain.com pointing at my server.
First, be sure that your DNS has finished resolving before attempting to enable TLS. If your DNS is not working yet, you could be instantly throttled by Let's Encrypt for up to a week. To test your DNS you can use http:
http://example-domain.com
​
reverse_proxy localhost:3000
and restart Caddy:
sudo systemctl reload snap.rocketchat-server.rocketchat-caddy
You can check that the Caddy service started correctly by running:
sudo systemctl status snap.rocketchat-server.rocketchat-caddy
Once that is tested and resolved, to get secured communications, you can remove the http://:
example-domain.com
​
reverse_proxy localhost:3000
Please note: using an IP address will not work for automatically enabling TLS with a publicly-trusted certificate. You must use a valid hostname for a trusted certificate (here's why). If you use an IP address, Caddy will still serve your site over TLS, but using a self-signed certificate.
Now you can restart the Caddy service by running:
sudo systemctl reload snap.rocketchat-server.rocketchat-caddy
You can check that the Caddy service started correctly by running:
sudo systemctl status snap.rocketchat-server.rocketchat-caddy
If everything went well, the site will be accessible at https://example-domain.com.
Testing with an Untrusted Self-Signed Certificate
Simply add the tls internal directive to your Caddyfile like so:
https://example-domain.com
​
reverse_proxy localhost:3000
tls internal
Remember to reload the Caddy service:
sudo systemctl reload snap.rocketchat-server.rocketchat-caddy
This will enable TLS with an untrusted, self-signed certificate for testing purposes.
For details on the Caddy TLS directive, visit https://caddyserver.com/docs/tls​
Disabling TLS or Listening on Custom Ports
This configuration will listen without TLS on the default port 80:
http://example-domain.com
​
reverse_proxy localhost:3000
This configuration will listen without TLS on port 8080:
http://example-domain.com:8080
​
reverse_proxy localhost:3000
This configuration will listen with TLS on port 8080:
example-domain.com:8080
​
reverse_proxy localhost:3000
Note that you can use an IP address and Caddy will serve it with TLS using a self-signed certificate:
192.168.1.1:8080
​
reverse_proxy localhost:3000
Remember to reload the Caddy service:
sudo systemctl reload snap.rocketchat-server.rocketchat-caddy
Opening ports when running Rocket.Chat Server from behind router
For Caddy to be able to work from behind a router, the following ports need to be opened between the internet and the server. This is usually achieved through router software or web-interface.
HTTP: port 80
HTTPS: port 443

Configuring MongoDB

Snap Backup and Restore

Last modified 1mo ago

Export as PDF

Copy link

Outline

Configure everything using snap

Check Caddy's logs

Configure Caddy yourself or use another HTTP Proxy

Testing with an Untrusted Self-Signed Certificate

Disabling TLS or Listening on Custom Ports

Opening ports when running Rocket.Chat Server from behind router