2025-05-02 22:23:39 +00:00
|
|
|
# Tuwunel for Debian
|
2020-11-13 20:50:58 +01:00
|
|
|
|
2024-11-23 22:35:54 -05:00
|
|
|
Information about downloading and deploying the Debian package. This may also be
|
|
|
|
|
referenced for other `apt`-based distros such as Ubuntu.
|
2023-07-23 12:34:48 +02:00
|
|
|
|
2024-05-13 22:50:40 -04:00
|
|
|
### Installation
|
2023-07-23 12:34:48 +02:00
|
|
|
|
2024-11-23 22:35:54 -05:00
|
|
|
It is recommended to see the [generic deployment guide](../deploying/generic.md)
|
|
|
|
|
for further information if needed as usage of the Debian package is generally
|
|
|
|
|
related.
|
2020-11-13 20:50:58 +01:00
|
|
|
|
2024-12-15 22:46:56 -05:00
|
|
|
No `apt` repository is currently offered yet, it is in the works/development.
|
|
|
|
|
|
2024-05-13 22:50:40 -04:00
|
|
|
### Configuration
|
2020-11-13 20:50:58 +01:00
|
|
|
|
2025-05-02 22:23:39 +00:00
|
|
|
When installed, the example config is placed at `/etc/tuwunel/tuwunel.toml`
|
2024-11-23 22:35:54 -05:00
|
|
|
as the default config. The config mentions things required to be changed before
|
|
|
|
|
starting.
|
2020-11-13 20:50:58 +01:00
|
|
|
|
2024-11-23 22:35:54 -05:00
|
|
|
You can tweak more detailed settings by uncommenting and setting the config
|
2025-05-02 22:23:39 +00:00
|
|
|
options in `/etc/tuwunel/tuwunel.toml`.
|
2020-11-13 20:50:58 +01:00
|
|
|
|
2024-05-13 22:50:40 -04:00
|
|
|
### Running
|
2020-11-13 20:50:58 +01:00
|
|
|
|
2025-05-02 22:23:39 +00:00
|
|
|
The package uses the [`tuwunel.service`](../configuration/examples.md#example-systemd-unit-file)
|
|
|
|
|
systemd unit file to start and stop Tuwunel. The binary is installed at `/usr/sbin/tuwunel`.
|
2024-05-13 22:50:40 -04:00
|
|
|
|
2025-05-02 22:23:39 +00:00
|
|
|
This package assumes by default that Tuwunel will be placed behind a reverse
|
|
|
|
|
proxy. The default config options apply (listening on `localhost` and TCP port
|
|
|
|
|
`6167`). Matrix federation requires a valid domain name and TLS, so you will
|
|
|
|
|
need to set up TLS certificates and renewal for it to work properly if you
|
|
|
|
|
intend to federate.
|
2024-05-13 22:50:40 -04:00
|
|
|
|
2025-05-02 22:23:39 +00:00
|
|
|
Consult various online documentation and guides on setting up a reverse proxy
|
|
|
|
|
and TLS. Caddy is documented at the [generic deployment guide](../deploying/generic.md#setting-up-the-reverse-proxy)
|
|
|
|
|
as it's the easiest and most user friendly.
|
