diff --git a/MANIFEST.in b/MANIFEST.in index fa74034..5e72df9 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,17 +1,19 @@ include LICENSE include INSTALL include README include MANIFEST.in include debian/changelog include debian/compat include debian/control include debian/copyright +include debian/docs include debian/install include debian/lintian-overrides include debian/msrprelay.service include debian/rules include debian/source/format +include debian/README.Debian recursive-include test README *.py recursive-include tls README *.sh diff --git a/debian/README.Debian b/debian/README.Debian new file mode 100644 index 0000000..d911c14 --- /dev/null +++ b/debian/README.Debian @@ -0,0 +1,31 @@ + +Server configuration +-------------------- + +The server configuration is at /etc/msrprelay/config.ini + +At the very least the TLS certificates and the authentication +backend need to be configured. + +Self signed TLS certificates can be generated using the scripts +that can be found at /usr/share/msrprelay/tls + +The relay will reload its configuration file when it receives the HUP signal. +All of the already established sessions will continue to work using the old +settings until they disconnect. This allows for changes in the configuration +without disruption of service. + +Note: at the moment the backend configurations are not re-read. + + +DNS configuration +----------------- + +For each domain served by the relay the following DNS record must be added to +the name servers authoritative for the domain: + +_msrps._tcp.example.com. IN SRV 0 0 2855 msrprelay.example.com. +msrprelay.example.com. IN A 10.0.0.1 + +Replace the domain name, hostname and IP address with the real ones. + diff --git a/debian/docs b/debian/docs new file mode 100644 index 0000000..151b8ff --- /dev/null +++ b/debian/docs @@ -0,0 +1,2 @@ +README +debian/README.Debian