Difference between revisions of "Setup Start Parameter"
| (116 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Create a JSON file with the [[Start Object]] and host it under URL <code>http://{SERVER}/msx/start.json</code>. The <code>{SERVER}</code> part is entered via the Media Station X application as hostname or IP address. | Create a JSON file with the [[Start Object]] and host it under URL <code>http://{SERVER}/msx/start.json</code>. The <code>{SERVER}</code> part is entered via the Media Station X application as hostname or IP address. | ||
| − | '''Note: Since version 0.1.88, you can also load the start parameter via HTTPS (i.e. <code>https://{SERVER}/msx/start.json</code>) by setting the security lock during setup. Please note that the security lock is only applied to the start parameter file, for the other JSON files, you must always indicate full URLs that have to start with the protocol (i.e. <code>http://</code> or <code>https://</code>). Please also note that if the Media Station X application is loaded via HTTPS (i.e. https://msx.benzac.de), the security lock must always be set and all JSON files and plugins must be provided via HTTPS (the application will automatically update the protocol from <code>http://</code> to <code>https://</code> for these URLs). In a secure context, it is also recommended to provide all media content (i.e. videos, | + | '''Note: Since version 0.1.88, you can also load the start parameter via HTTPS (i.e. <code>https://{SERVER}/msx/start.json</code>) by setting the security lock during setup. Please note that the security lock is only applied to the start parameter file, for the other JSON files, you must always indicate full URLs that have to start with the protocol (i.e. <code>http://</code> or <code>https://</code>). Please also note that if the Media Station X application is loaded via HTTPS (i.e. https://msx.benzac.de), the security lock must always be set and all JSON files and plugins must be provided via HTTPS (the application will automatically update the protocol from <code>http://</code> to <code>https://</code> for these URLs). In a secure context, it is also recommended to provide all media content (i.e. videos, audios, and images) via HTTPS to avoid mixed content issues (the application will not update the protocol for these URLs). Since version 0.1.140, you can adjust the protocol update settings with a URL parameter. Please see the <code>secure</code> parameter from the [[URL Parameters]].''' |
If the JSON file is hosted, please go to your corresponding application store, install and launch the '''Media Station X''' application, navigate to '''Settings''' → '''Start Parameter''' → '''Setup''', and follow the setup instructions. Once you have completed the start parameter setup, your content is loaded every time you start the application. | If the JSON file is hosted, please go to your corresponding application store, install and launch the '''Media Station X''' application, navigate to '''Settings''' → '''Start Parameter''' → '''Setup''', and follow the setup instructions. Once you have completed the start parameter setup, your content is loaded every time you start the application. | ||
| − | + | For corresponding application stores, please visit: https://msx.benzac.de/info/?tab=PlatformSupport. | |
== Example Screenshot (Setup Start Parameter) == | == Example Screenshot (Setup Start Parameter) == | ||
| − | + | [[File:start.png|thumb|640px|none|For this example screenshot, the requested URL is <code>http://192.168.0.10:8080/msx/start.json</code>.]] | |
| − | |||
| − | | | ||
| − | | For this example screenshot, the requested URL is <code>http://192.168.0.10:8080/msx/start.json</code>. | ||
| − | |||
== Example Screenshot (Complete Start Parameter) == | == Example Screenshot (Complete Start Parameter) == | ||
| − | + | [[File:complete.png|thumb|640px|none|After the start parameter has been successfully loaded, you can set it up. For this example screenshot, the start parameter is a menu with URL <code>http://192.168.0.10:8080/msx/menu.json</code>.]] | |
| − | |||
| − | | | ||
| − | | After the start parameter has been successfully loaded, you can set it up. For this example screenshot, the start parameter is a menu with URL <code>http://192.168.0.10:8080/msx/menu.json</code>. | ||
| − | |||
== Example Screenshot (Configured Start Parameter) == | == Example Screenshot (Configured Start Parameter) == | ||
| − | + | [[File:holiday.png|thumb|640px|none|After the start parameter has been set up, your content is loaded every time you start the application. If your content can not be loaded, you will get an error message at startup. You can change or reset the start parameter at any time via the settings.]] | |
| − | | | + | |
| + | == Content Examples == | ||
| + | [[File:screens2.png|thumb|640px|none|Some example screenshots of how you can customize your content.]] | ||
| + | |||
| + | == URL Shortener Services == | ||
| + | If you would like to host the [[Start Object]] under a specific path (e.g. <code>http://example.com/path/to/start/object</code>) or you need a specific query (e.g. <code>http://example.com/msx/start.php?key1=value1&key2=value2</code>), you can use a URL shortener service and the special start parameter ID syntax <code>id:{SERVICE_ID}:{ALIAS}</code> (e.g. <code>id:bly:example</code>) to set it up. This feature can be used with version '''0.1.97''' or higher. Currently, following free URL shortener services are supported. | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |+ URL shortener services | ||
|- | |- | ||
| − | | | + | ! Service !! Link || ID || Shortened URL Example !! Start Parameter Example !! Remarks |
| + | |- | ||
| + | | Bitly || https://bitly.com || <code>bly</code> || https://bit.ly/example || <code>id:bly:example</code> || This service only supports auto-generated aliases. | ||
| + | |- | ||
| + | | Cuttly || https://cutt.ly || <code>cly</code> || https://cutt.ly/example || <code>id:cly:example</code> || This service only supports auto-generated aliases. | ||
| + | |- | ||
| + | | T.LY || https://t.ly || <code>tly</code> || https://t.ly/example || <code>id:tly:example</code> || This service only supports auto-generated aliases. | ||
| + | |- | ||
| + | | Rebrandly || https://www.rebrandly.com || <code>rly</code> || https://rb.gy/example || <code>id:rly:example</code> || This service only supports auto-generated aliases. | ||
| + | |- | ||
| + | | is.gd || https://is.gd || <code>igd</code> || https://is.gd/example || <code>id:igd:example</code> || This service supports auto-generated and custom aliases. | ||
| + | |- | ||
| + | | v.gd || https://v.gd || <code>vgd</code> || https://v.gd/example || <code>id:vgd:example</code> || This service supports auto-generated and custom aliases. | ||
| + | |- | ||
| + | | TinyURL || https://tinyurl.com | ||
| + | || | ||
| + | <code>trl</code><br/> | ||
| + | <code>tny</code><br/> | ||
| + | <code>rtf</code><br/> | ||
| + | || | ||
| + | https://tinyurl.com/example<br/> | ||
| + | https://tiny.io/example<br/> | ||
| + | https://rotf.lol/example<br/> | ||
| + | || | ||
| + | <code>id:trl:example</code><br/> | ||
| + | <code>id:tny:example</code><br/> | ||
| + | <code>id:rtf:example</code><br/> | ||
| + | || | ||
| + | This service supports auto-generated and custom aliases. | ||
| + | |- | ||
| + | | PHP-Redirect || n/a || <code>php</code> || n/a || <code>id:php:example.com</code> || This service is not a URL shortener, but a simple PHP redirect service. It can be used to load the [[Start Object]] from a PHP instead of a JSON file (e.g. <code>id:php:example.com</code> → <code>http://example.com/msx/start.php</code>). | ||
|} | |} | ||
| + | |||
| + | '''Note: Please note that no URLs are stored or cached on MSX servers. Each URL is stored exclusively on the used service. It is recommended to read the privacy policy of the used service before registering URLs. Please also note that the start parameter input only supports numbers (<code>0</code> to <code>9</code>) and lowercase letters (<code>a</code> to <code>z</code>). If the alias contains uppercase letters (<code>A</code> to <code>Z</code>), you have to put a dash (<code>-</code>) before each uppercase letter (e.g. <code>eXaMpLe</code> → <code>e-xa-mp-le</code>). Please also note that if the security lock is set during setup, the protocol from the registered URL is automatically updated from <code>http://</code> to <code>https://</code>.''' | ||
| + | |||
| + | It is also possible to register URLs that contain the <code>start</code> URL parameter (please see [[URL Parameters]]). In these cases, the <code>start</code> URL parameter is extracted and used as start parameter (e.g. <code>http://msx.benzac.de/?start=menu:user:http://sc.msx.benzac.de/msx/service.php</code> → <code>menu:user:http://sc.msx.benzac.de/msx/service.php</code>). This feature allows you to create short URLs that are launchable (via browser) and registerable (via application). Please see following examples. | ||
| + | |||
| + | * SoundCloud MSX: https://bit.ly/3Oys4Xx (<code>id:bly:3-oys4-xx</code>) | ||
| + | * Experts Content Guide: https://bit.ly/3b5000l (<code>id:bly:3b5000l</code>) | ||
| + | * MRSS Example Channel: https://bit.ly/3zzxOvK (<code>id:bly:3zzx-ov-k</code>) | ||
| + | |||
| + | If the <code>start</code> URL parameter is set, you can also set an <code>alias</code> URL parameter, which is then displayed when setting up the start parameter (e.g. <code>http://msx.benzac.de/?start=menu:user:http://sc.msx.benzac.de/msx/service.php&alias=SoundCloud%20MSX</code> → <code>SoundCloud MSX</code>). Otherwise, the used service with the entered alias is displayed (e.g. <code>Bitly MSX | 3-oys4-xx</code>). | ||
| + | |||
| + | The special start parameter ID syntax is also supported by the '''Launcher MSX''' service. For this service, you can (if the <code>start</code> URL parameter is set) set additional URL parameters (<code>type</code>, <code>icon</code>, <code>image</code>, and <code>color</code>) that are also extracted and used as launcher properties. Please see [[Tips_%26_Tricks#Launcher_MSX]] for more information. | ||
| + | |||
| + | == See also == | ||
| + | * [[Start Object]] | ||
| + | * [[Setup Precondition]] | ||
Latest revision as of 08:14, 19 April 2024
Create a JSON file with the Start Object and host it under URL http://{SERVER}/msx/start.json. The {SERVER} part is entered via the Media Station X application as hostname or IP address.
Note: Since version 0.1.88, you can also load the start parameter via HTTPS (i.e. https://{SERVER}/msx/start.json) by setting the security lock during setup. Please note that the security lock is only applied to the start parameter file, for the other JSON files, you must always indicate full URLs that have to start with the protocol (i.e. http:// or https://). Please also note that if the Media Station X application is loaded via HTTPS (i.e. https://msx.benzac.de), the security lock must always be set and all JSON files and plugins must be provided via HTTPS (the application will automatically update the protocol from http:// to https:// for these URLs). In a secure context, it is also recommended to provide all media content (i.e. videos, audios, and images) via HTTPS to avoid mixed content issues (the application will not update the protocol for these URLs). Since version 0.1.140, you can adjust the protocol update settings with a URL parameter. Please see the secure parameter from the URL Parameters.
If the JSON file is hosted, please go to your corresponding application store, install and launch the Media Station X application, navigate to Settings → Start Parameter → Setup, and follow the setup instructions. Once you have completed the start parameter setup, your content is loaded every time you start the application.
For corresponding application stores, please visit: https://msx.benzac.de/info/?tab=PlatformSupport.
Example Screenshot (Setup Start Parameter)[edit]
http://192.168.0.10:8080/msx/start.json.Example Screenshot (Complete Start Parameter)[edit]
http://192.168.0.10:8080/msx/menu.json.Example Screenshot (Configured Start Parameter)[edit]
Content Examples[edit]
URL Shortener Services[edit]
If you would like to host the Start Object under a specific path (e.g. http://example.com/path/to/start/object) or you need a specific query (e.g. http://example.com/msx/start.php?key1=value1&key2=value2), you can use a URL shortener service and the special start parameter ID syntax id:{SERVICE_ID}:{ALIAS} (e.g. id:bly:example) to set it up. This feature can be used with version 0.1.97 or higher. Currently, following free URL shortener services are supported.
| Service | Link | ID | Shortened URL Example | Start Parameter Example | Remarks |
|---|---|---|---|---|---|
| Bitly | https://bitly.com | bly |
https://bit.ly/example | id:bly:example |
This service only supports auto-generated aliases. |
| Cuttly | https://cutt.ly | cly |
https://cutt.ly/example | id:cly:example |
This service only supports auto-generated aliases. |
| T.LY | https://t.ly | tly |
https://t.ly/example | id:tly:example |
This service only supports auto-generated aliases. |
| Rebrandly | https://www.rebrandly.com | rly |
https://rb.gy/example | id:rly:example |
This service only supports auto-generated aliases. |
| is.gd | https://is.gd | igd |
https://is.gd/example | id:igd:example |
This service supports auto-generated and custom aliases. |
| v.gd | https://v.gd | vgd |
https://v.gd/example | id:vgd:example |
This service supports auto-generated and custom aliases. |
| TinyURL | https://tinyurl.com |
|
https://tinyurl.com/example |
|
This service supports auto-generated and custom aliases. |
| PHP-Redirect | n/a | php |
n/a | id:php:example.com |
This service is not a URL shortener, but a simple PHP redirect service. It can be used to load the Start Object from a PHP instead of a JSON file (e.g. id:php:example.com → http://example.com/msx/start.php).
|
Note: Please note that no URLs are stored or cached on MSX servers. Each URL is stored exclusively on the used service. It is recommended to read the privacy policy of the used service before registering URLs. Please also note that the start parameter input only supports numbers (0 to 9) and lowercase letters (a to z). If the alias contains uppercase letters (A to Z), you have to put a dash (-) before each uppercase letter (e.g. eXaMpLe → e-xa-mp-le). Please also note that if the security lock is set during setup, the protocol from the registered URL is automatically updated from http:// to https://.
It is also possible to register URLs that contain the start URL parameter (please see URL Parameters). In these cases, the start URL parameter is extracted and used as start parameter (e.g. http://msx.benzac.de/?start=menu:user:http://sc.msx.benzac.de/msx/service.php → menu:user:http://sc.msx.benzac.de/msx/service.php). This feature allows you to create short URLs that are launchable (via browser) and registerable (via application). Please see following examples.
- SoundCloud MSX: https://bit.ly/3Oys4Xx (
id:bly:3-oys4-xx) - Experts Content Guide: https://bit.ly/3b5000l (
id:bly:3b5000l) - MRSS Example Channel: https://bit.ly/3zzxOvK (
id:bly:3zzx-ov-k)
If the start URL parameter is set, you can also set an alias URL parameter, which is then displayed when setting up the start parameter (e.g. http://msx.benzac.de/?start=menu:user:http://sc.msx.benzac.de/msx/service.php&alias=SoundCloud%20MSX → SoundCloud MSX). Otherwise, the used service with the entered alias is displayed (e.g. Bitly MSX | 3-oys4-xx).
The special start parameter ID syntax is also supported by the Launcher MSX service. For this service, you can (if the start URL parameter is set) set additional URL parameters (type, icon, image, and color) that are also extracted and used as launcher properties. Please see Tips_&_Tricks#Launcher_MSX for more information.