From 34bfd14164c71371a005b7a78b507db71ab6996c Mon Sep 17 00:00:00 2001 From: Thomas Biering Date: Fri, 16 Jul 2021 18:32:50 +0200 Subject: [PATCH] Improved descriptions and notes --- Template/template.json | 78 +++++++++++++++++++++++------------------- 1 file changed, 42 insertions(+), 36 deletions(-) diff --git a/Template/template.json b/Template/template.json index 8e71690..a92bf09 100644 --- a/Template/template.json +++ b/Template/template.json @@ -128,7 +128,7 @@ "image": "authelia/authelia:latest", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/authelia.png", "name": "authelia", - "note": "Requires a configuration.yml file in order to work. Documentation is Available \u003ca href='https://docs.authelia.com/deployment/deployment-ha'\u003ehere\u003c/a\u003e.", + "note": "Requires a configuration.yml file in order to work. Documentation is available here.", "platform": "linux", "ports": [ "9091:9091/tcp" @@ -237,7 +237,7 @@ "Other", "Tools" ], - "description": "This is a Bitwarden server API implementation written in Rust compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal..", + "description": "This is a Bitwarden server API implementation written in Rust compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.", "image": "bitwardenrs/server:latest", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/bitwarden.png", "name": "bitwardenrs", @@ -261,7 +261,7 @@ "Books", "Other" ], - "description": "Booksonic is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic", + "description": "Booksonic is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic.", "env": [ { "default": "1000", @@ -391,7 +391,7 @@ "Cloud", "Books" ], - "description": "Calibre Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.\n\n [br][br]\n [b][u][span style='color: #E80000;']Configuration[/span][/u][/b][br]\n [b]/config[/b] Where Calibre-web should store it's database[br]\n [b]/books[/b] Path to your calibre library metadata.db file[br]", + "description": "Calibre Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.", "env": [ { "default": "1000", @@ -407,6 +407,7 @@ "image": "linuxserver/calibre-web:latest", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/calibre-web-icon.png", "name": "calibre-web", + "note": "Configuration ", "platform": "linux", "ports": [ "8083:8083/tcp" @@ -431,7 +432,7 @@ "Tools", "Photo" ], - "description": "Chevereto is a powerful and fast image hosting script that allows you to create your very own full featured image hosting website in just minutes. Please note that this offers only the free Chevereto version..", + "description": "Chevereto is a powerful and fast image hosting script that allows you to create your very own full featured image hosting website in just minutes. Please note that this offers only the free Chevereto version.", "env": [ { "default": "1000", @@ -564,7 +565,7 @@ "categories": [ "Productivity" ], - "description": "Codiad is a web-based IDE framework with a small footprint and minimal requirements.\n ", + "description": "Codiad is a web-based IDE framework with a small footprint and minimal requirements.", "env": [ { "default": "1000", @@ -701,7 +702,7 @@ "Other", "Tools" ], - "description": "davos is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow.\r\n\r\n/config : AppData Location\r\n/download : File Download Location", + "description": "davos is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow.", "env": [ { "default": "1000", @@ -717,6 +718,7 @@ "image": "linuxserver/davos:latest", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/davos.png", "name": "davos", + "note": "Configuration ", "platform": "linux", "ports": [ "8080/tcp" @@ -744,7 +746,7 @@ "image": "registry.gitlab.com/bockiii/deemix-docker", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/deemix.png", "name": "deemix", - "note": "Deemix may take a few minutes to install. Be sure to check the logs for details. Refer to \u003ca href='https://notabug.org/RemixDevs/DeezloaderRemix/wiki/Login+via+userToken'\u003ethis page\u003c/a\u003e for userToken details.", + "note": "Deemix may take a few minutes to install. Be sure to check the logs for details. Refer to this page for userToken details.", "platform": "linux", "ports": [ "9666:9666/tcp" @@ -808,7 +810,7 @@ "HomeAutomation", "Management" ], - "description": "Domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device", + "description": "Domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device.", "env": [ { "default": "1000", @@ -845,7 +847,7 @@ "DNS", "Tools" ], - "description": "Duck DNS is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence.\r\n\r\nFirst, go to duckdns site, register your subdomain and retrieve your token\r\nThen run the docker create command above with your subdomain(s) and token\r\nIt will update your IP with the DuckDNS service every 5 minutes\r\n\r\n", + "description": "Duck DNS is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence.", "env": [ { "label": "SUBDOMAINS", @@ -871,6 +873,7 @@ "image": "linuxserver/duckdns:latest", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/duckdns.png", "name": "duckdns", + "note": "Configuration
First, go to duckdns site, register your subdomain and retrieve your token
Then run the docker create command above with your subdomain(s) and token
It will update your IP with the DuckDNS service every 5 minutes", "platform": "linux", "restart_policy": "unless-stopped", "title": "Duck DNS", @@ -1028,7 +1031,7 @@ "categories": [ "Other" ], - "description": "A free, self-hostable rss aggregator…", + "description": "A free, self-hostable rss aggregator.", "env": [ { "default": "1000", @@ -1064,7 +1067,7 @@ "Books", "Tools" ], - "description": "A WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser", + "description": "A WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser.", "env": [ { "default": "1000", @@ -1129,7 +1132,7 @@ "Tools", "Finance" ], - "description": "Grocy is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utulity.", + "description": "Grocy is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utility.", "env": [ { "default": "1000", @@ -1169,7 +1172,7 @@ "Music", "Other" ], - "description": "HTPC Manaager, a front end for many htpc related applications. Hellowlol version.", + "description": "HTPC Manager, a front end for many htpc related applications. Uses the Hellowlol HTPC Manager fork.", "env": [ { "default": "1000", @@ -1203,7 +1206,7 @@ "categories": [ "Music" ], - "description": null, + "description": "Headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.", "env": [ { "default": "1000", @@ -1367,7 +1370,7 @@ ], "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/invoice_ninja.png", "name": "invoice_ninja", - "note": "The database user is invoice_ninja and the database is ninja_db. Please generate an app key following the documentation \u003ca href='https://github.com/invoiceninja/dockerfiles'\u003ehere\u003c/a\u003e. ", + "note": "The database user is invoice_ninja and the database is ninja_db. Please generate an app key following the documentation here. ", "platform": "linux", "repository": { "stackfile": "Template/Stack/invoice-ninja.yml", @@ -1381,7 +1384,7 @@ "Downloaders", "Tools" ], - "description": "Jackett works as a proxy server it translates queries from apps like Sonarr etc into tracker-site-specific http queries and parses the html response sending results back to the requesting software.[", + "description": "Jackett works as a proxy server it translates queries from apps like Sonarr etc into tracker-site-specific http queries and parses the html response sending results back to the requesting software.", "env": [ { "default": "1000", @@ -1543,7 +1546,7 @@ "Tools", "Web" ], - "description": "This container sets up an Nginx webserver and reverse proxy with php support and a built-in letsencrypt client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention.\r\n \r\n Before running this container, make sure that the url and subdomains are properly forwarded to this container's host.\r\n \r\n - Port 443 on the internet side of the router should be forwarded to this container's port 443.\r\n - If you need a dynamic dns provider, you can use the free provider duckdns.org where the url will be yoursubdomain.duckdns.org and the subdomains can be www,ftp,cloud\r\n - The container detects changes to url and subdomains, revokes existing certs and generates new ones during start. \r\n - It also detects changes to the DHLEVEL parameter and replaces the dhparams file.\r\n \r\n - If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file docker exec -it letsencrypt htpasswd -c /config/nginx/.htpasswd \u0026lt;username\u0026gt;", + "description": "This container sets up an Nginx webserver and reverse proxy with php support and a built-in letsencrypt client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention.", "env": [ { "label": "EMAIL", @@ -1594,6 +1597,7 @@ "image": "linuxserver/swag:latest", "logo": "https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Images/letsencrypt.png", "name": "letsencrypt / SWAG", + "note": "Before running this container, make sure that the url and subdomains are properly forwarded to this container's host.