AppFeed/templates/ich777sRepository/ich777/Stun-Turn-Server.xml
Squidly271 b3878cd225 Redo
2020-12-03 07:42:32 -05:00

205 lines
12 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Name>Stun-Turn-Server</Name>
<Repository>ich777/stun-turn-server</Repository>
<Registry>https://hub.docker.com/r/ich777/stun-turn-server</Registry>
<Network>bridge</Network>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/83786-support-ich777-application-dockers/</Support>
<Overview>This is a Basic STUN &amp;amp; TURN server that was mainly created for Nextcloud Talk.&#13;
&#13;
It is fully automated and will create all the necessary files and passwords so that the server can sucessfully start and run.&#13;
&#13;
Please read all the discriptions from the Variables carefully and also look at the 'Show more settings' tab.&#13;
&#13;
ATTENTION: Please ignore the socket errors after the server startup if you don't have IPv6 enabled on your server.</Overview>
<WebUI></WebUI>
<Icon>https://raw.githubusercontent.com/ich777/docker-templates/master/ich777/images/stun-turn.png</Icon>
<ExtraParams>--restart=unless-stopped</ExtraParams>
<PostArgs></PostArgs>
<CPUset></CPUset>
<DonateText>If you like my work please </DonateText>
<DonateLink>https://www.paypal.me/chips777</DonateLink>
<Networking>
<Mode>bridge</Mode>
<Publish>
<Port>
<HostPort>5349</HostPort>
<ContainerPort>5349</ContainerPort>
<Protocol>tcp</Protocol>
</Port>
<Port>
<HostPort>5349</HostPort>
<ContainerPort>5349</ContainerPort>
<Protocol>udp</Protocol>
</Port>
</Publish>
</Networking>
<Data>
<Volume>
<HostDir>/mnt/cache/appdata/stun-turn-server</HostDir>
<ContainerDir>/stun-turn</ContainerDir>
<Mode>rw</Mode>
</Volume>
</Data>
<Environment>
<Variable>
<Value>5349</Value>
<Name>PORT</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>SECRET</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>minenet.at</Value>
<Name>REALM</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>cert.pem</Value>
<Name>CERT_FILE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>privkey.pem</Value>
<Name>PRIVKEY_FILE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>dhparam.pem</Value>
<Name>DH_FILE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>true</Value>
<Name>DISPLAY_SECRETS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>US</Value>
<Name>CA_COUNTRY</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>EXTRA_PARAMS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>100</Value>
<Name>TOTAL_QUOTA</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>0</Value>
<Name>MAX_BPS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384</Value>
<Name>CIPHER_LIST</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>2048</Value>
<Name>CERT_LENGTH</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>3650</Value>
<Name>CERT_VALID_DAYS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>None</Value>
<Name>CA_STATE_PROV</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>None</Value>
<Name>CA_LOCALITY</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>None</Value>
<Name>CA_ORGANIZATION</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>2048</Value>
<Name>DH_LENGTH</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>CLI_PASSWORD</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>000</Value>
<Name>UMASK</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>99</Value>
<Name>UID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>100</Value>
<Name>GID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>770</Value>
<Name>DATA_PERM</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>0.0.0.0</Value>
<Name>LISTENING_IP</Name>
<Mode></Mode>
</Variable>
</Environment>
<Config Name="Container Path" Target="/stun-turn" Default="" Mode="rw" Description="Container Path: /stun-turn" Type="Path" Display="always" Required="true" Mask="false">/mnt/cache/appdata/stun-turn-server</Config>
<Config Name="TCP Port" Target="5349" Default="" Mode="tcp" Description="TCP Port" Type="Port" Display="always" Required="true" Mask="false">5349</Config>
<Config Name="UDP Ports" Target="5349" Default="" Mode="udp" Description="UDP Port" Type="Port" Display="always" Required="true" Mask="false">5349</Config>
<Config Name="Port Variable" Target="PORT" Default="" Mode="" Description="If you change this variable you have to create two new port forwardings with the corresponding ports one for TCP and one for UDP." Type="Variable" Display="always" Required="true" Mask="false">5349</Config>
<Config Name="Static Secret" Target="SECRET" Default="" Mode="" Description="Create your own secret and enter it here or leave empty and the server creats a secret that is stored into 'secret.txt' in the main directory of the container (generate it for example in a linux terminal with the command 'openssl rand -hex 32' without quotes)." Type="Variable" Display="always" Required="false" Mask="true"></Config>
<Config Name="Realm" Target="REALM" Default="" Mode="" Description="Your hostname (eg: 'example.org' without quotes)." Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Certificate File Name" Target="CERT_FILE" Default="" Mode="" Description="Name of the certification file (leave empty if the server should create one or replace it with your own)." Type="Variable" Display="always" Required="true" Mask="false">cert.pem</Config>
<Config Name="Private Key File Name" Target="PRIVKEY_FILE" Default="" Mode="" Description="Name of the private key file (leave empty if the server should create one or replace it with your own)." Type="Variable" Display="always" Required="true" Mask="false">privkey.pem</Config>
<Config Name="Diffie-Hellman Key File Name" Target="DH_FILE" Default="" Mode="" Description="Name of the DiffieHellman key file (leave empty if the server should create one or replace it with your own - also plase look under the 'Show more settings' tab if you want to generate a bigger or smaller key default is: 2048)." Type="Variable" Display="always" Required="true" Mask="false">dhparam.pem</Config>
<Config Name="Display Secrets in log" Target="DISPLAY_SECRETS" Default="" Mode="" Description="Display your secrets in the log (set to 'true' or leave empty to disable it)." Type="Variable" Display="always" Required="false" Mask="false">true</Config>
<Config Name="Certificate Generation - Country" Target="CA_COUNTRY" Default="" Mode="" Description="Country code for your certificate if the server should create one (two letters eg: 'US' without quotes - also plase look under the 'Show more settings' tab there are more settings for generating your certificate)." Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Extra Startup Parameters" Target="EXTRA_PARAMS" Default="" Mode="" Description="Here you can enter your Extra Startup Parameters if needed (you can get a full list of commands from here: https://github.com/coturn/coturn/wiki/turnserver)" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Total Quota" Target="TOTAL_QUOTA" Default="" Mode="" Description="Total allocations quota: global limit on concurrent allocations (only change if you know what you are doing)." Type="Variable" Display="advanced" Required="true" Mask="false">100</Config>
<Config Name="Maximum bps" Target="MAX_BPS" Default="" Mode="" Description="Max bytes-per-second bandwidth a TURN session is allowed to handle (input and output network streams are treated separately). Anything above that limit will be dropped or temporary suppressed - within the available buffer limits (only change if you know what you are doing)." Type="Variable" Display="advanced" Required="true" Mask="false">0</Config>
<Config Name="Cipher List" Target="CIPHER_LIST" Default="" Mode="" Description="Allowed OpenSSL cipher list for TLS/DTLS connections (only change if you know what you are doing)." Type="Variable" Display="advanced" Required="true" Mask="false">ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384</Config>
<Config Name="Certificate Generation - Key Length" Target="CERT_LENGTH" Default="" Mode="" Description="Enter your preferred key length (the higher the value the longer it takes to generate the certificate)." Type="Variable" Display="advanced" Required="true" Mask="false">2048</Config>
<Config Name="Certificate Generation - Valid Days" Target="CERT_VALID_DAYS" Default="" Mode="" Description="Specify how long that the certificate should be valid in days." Type="Variable" Display="advanced" Required="true" Mask="false">3650</Config>
<Config Name="Certificate Generation - State or Province" Target="CA_STATE_PROV" Default="" Mode="" Description="Specify your state or province." Type="Variable" Display="advanced" Required="true" Mask="false">None</Config>
<Config Name="Certificate Generation - Locality" Target="CA_LOCALITY" Default="" Mode="" Description="Specify your locality." Type="Variable" Display="advanced" Required="true" Mask="false">None</Config>
<Config Name="Certificate Generation - Organization" Target="CA_ORGANIZATION" Default="" Mode="" Description="Specify your organiszation." Type="Variable" Display="advanced" Required="true" Mask="false">None</Config>
<Config Name="DiffieHellman Key Length" Target="DH_LENGTH" Default="" Mode="" Description="Enter your preferred key length (the higher the value the longer it takes to generate the key)." Type="Variable" Display="advanced" Required="true" Mask="false">2048</Config>
<Config Name="Command Line Password" Target="CLI_PASSWORD" Default="" Mode="" Description="Enter your CLI password or leave empty if you want that the server creates a random one (please note that you have to manually enable the console with the '--cli-port PORT' - PORT stands for your preferred port - in the Extra Startup Parameters and create the corresponding port)." Type="Variable" Display="advanced" Required="false" Mask="true"></Config>
<Config Name="Listening IP" Target="LISTENING_IP" Default="" Mode="" Description="Specify the listening port (only change if you know what you are doing)." Type="Variable" Display="advanced" Required="true" Mask="false">0.0.0.0</Config>
<Config Name="UMASK" Target="UMASK" Default="" Mode="" Description="Container Variable: 000" Type="Variable" Display="advanced" Required="true" Mask="false">000</Config>
<Config Name="UID" Target="UID" Default="" Mode="" Description="Container Variable: UID" Type="Variable" Display="advanced" Required="true" Mask="false">99</Config>
<Config Name="GID" Target="GID" Default="" Mode="" Description="Container Variable: GID" Type="Variable" Display="advanced" Required="true" Mask="false">100</Config>
<Config Name="DATA_PERM" Target="DATA_PERM" Default="" Mode="" Description="Container Variable: DATA_PERM" Type="Variable" Display="advanced" Required="true" Mask="false">770</Config>
<Category>Network:</Category>
<Description>This is a Basic STUN &amp;amp; TURN server that was mainly created for Nextcloud Talk.&#13;
&#13;
It is fully automated and will create all the necessary files and passwords so that the server can sucessfully start and run.&#13;
&#13;
Please read all the discriptions from the Variables carefully and also look at the 'Show more settings' tab.&#13;
&#13;
ATTENTION: Please ignore the socket errors after the server startup if you don't have IPv6 enabled on your server.</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/ich777sRepository/ich777/Stun-Turn-Server.xml</templatePath>
</Container>