AppFeed/templates/breadlysmsRepository/speedflux-unraid.xml
2021-05-27 12:40:43 -04:00

106 lines
6.5 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Name>SpeedFlux</Name>
<Repository>ghcr.io/breadlysm/speedflux:latest</Repository>
<Registry>https://github.com/users/breadlysm/packages/container/package/speedflux</Registry>
<Network>bridge</Network>
<Shell>bash</Shell>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/109335-support-breadlysm-speedflux/</Support>
<Project>https://github.com/breadlysm/speedtest-to-influxdb</Project>
<Overview> This tool will continuosly run Speedtests at the chosen interval and export the data to InfluxDB. &amp;lt;br&amp;gt;&#13;
&amp;lt;br&amp;gt;&#13;
# What makes this different is that it's using the Ookla CLI tool which provides some expanded details that you can use to tag your Influx Data. &amp;lt;br&amp;gt;&#13;
&amp;lt;br&amp;gt;&#13;
An example of the dashboard I made in Grafana can be found at https://grafana.com/grafana/dashboards/13053. &amp;lt;br&amp;gt;&#13;
&amp;lt;br&amp;gt;&#13;
&amp;lt;strong&amp;gt; This container only includes the scripts to run the speedtests and export to Influx. InfluxDB must be installed seperatly. I welcome feedback or additional improvements. Please open an issue on the project page. &amp;lt;/strong&amp;gt;&amp;lt;br&amp;gt;</Overview>
<WebUI></WebUI>
<TemplateURL>https://raw.githubusercontent.com/breadlysm/Breads-unraid-templates/main/speedflux-unraid.xml</TemplateURL>
<Icon>https://user-images.githubusercontent.com/3665468/119735610-974a0500-be4a-11eb-9149-dd12ceee03df.png</Icon>
<PostArgs></PostArgs>
<CPUset></CPUset>
<Networking>
<Mode>bridge</Mode>
<Publish></Publish>
</Networking>
<Data></Data>
<Environment>
<Variable>
<Value>influxdb</Value>
<Name>INFLUX_DB_ADDRESS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>8086</Value>
<Name>INFLUX_DB_PORT</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>INFLUX_DB_USER</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>INFLUX_DB_PASSWORD</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>speedtest</Value>
<Name>INFLUX_DB_DATABASE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>150</Value>
<Name>SPEEDTEST_INTERVAL</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>isp, external_ip, server_id, server_name, server_location, speedtest_url</Value>
<Name>INFLUX_DB_TAGS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>60</Value>
<Name>PING_INTERVAL</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>1.1.1.1, 8.8.8.8</Value>
<Name>PING_TARGETS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>info</Value>
<Name>LOG_TYPE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>SPEEDTEST_SERVER_ID</Name>
<Mode></Mode>
</Variable>
</Environment>
<Config Name="InfluxDB Address" Target="INFLUX_DB_ADDRESS" Default="" Mode="" Description="Container Variable: INFLUX_DB_ADDRESS&#13;&#10;IP or Hostname of Influx DB" Type="Variable" Display="always" Required="true" Mask="false">influxdb</Config>
<Config Name="InfluxDB Port" Target="INFLUX_DB_PORT" Default="8086" Mode="" Description="Container Variable: INFLUX_DB_PORT" Type="Variable" Display="always" Required="true" Mask="false">8086</Config>
<Config Name="InfluxDB User" Target="INFLUX_DB_USER" Default="" Mode="" Description="Container Variable: INFLUX_DB_USER" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="InfluxDB Pass" Target="INFLUX_DB_PASSWORD" Default="" Mode="" Description="Container Variable: INFLUX_DB_PASSWORD" Type="Variable" Display="always" Required="false" Mask="true"></Config>
<Config Name="InfluxDB Database Name" Target="INFLUX_DB_DATABASE" Default="" Mode="" Description="Container Variable: INFLUX_DB_DATABASE&#13;&#10;If the database doesn't exist, it will be created. " Type="Variable" Display="always" Required="true" Mask="false">speedtest</Config>
<Config Name="Test Interval" Target="SPEEDTEST_INTERVAL" Default="150" Mode="" Description="How often should speed be tested, in minutes. Default is set at 2:30 as I like to see changes over time at different times of day. " Type="Variable" Display="always" Required="false" Mask="false">150</Config>
<Config Name="InfluxDB Tags" Target="INFLUX_DB_TAGS" Default="isp, external_ip, server_id, server_name, server_location, speedtest_url" Mode="" Description="Tags to be added to the datasets. See https://github.com/breadlysm/speedtest-to-influxdb#tag-options. Tags must be comma seperated" Type="Variable" Display="always" Required="false" Mask="false">isp, external_ip, server_id, server_name, server_location, speedtest_url</Config>
<Config Name="Ping Interval" Target="PING_INTERVAL" Default="60" Mode="" Description="Interval is in seconds. This is how often your latency will be checked. " Type="Variable" Display="always" Required="false" Mask="false">60</Config>
<Config Name="Ping Servers" Target="PING_TARGETS" Default="1.1.1.1, 8.8.8.8" Mode="" Description="hostnames or domains to use to test ping. On every ping interval, all servers input will be tested. Must be comma seperated. " Type="Variable" Display="always" Required="false" Mask="false">1.1.1.1, 8.8.8.8</Config>
<Config Name="Log Level" Target="LOG_TYPE" Default="info" Mode="" Description="Options are: 'info' or 'debug' " Type="Variable" Display="advanced" Required="false" Mask="false">info</Config>
<Config Name="(Optional) Server ID" Target="SPEEDTEST_SERVER_ID" Default="" Mode="" Description="Input a Ookla Speedtest server ID to use for your tests. This will use this server for every test. " Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Date>1622066924</Date>
<Description>This tool will continuosly run Speedtests at the chosen interval and export the data to InfluxDB. &#13;
&#13;
# What makes this different is that it's using the Ookla CLI tool which provides some expanded details that you can use to tag your Influx Data. &#13;
&#13;
An example of the dashboard I made in Grafana can be found at https://grafana.com/grafana/dashboards/13053. &#13;
&#13;
This container only includes the scripts to run the speedtests and export to Influx. InfluxDB must be installed seperatly. I welcome feedback or additional improvements. Please open an issue on the project page.</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/breadlysmsRepository/speedflux-unraid.xml</templatePath>
</Container>