Updated FAQ (markdown)

CDeenen
2021-01-15 10:44:59 +01:00
parent e342104bcc
commit c7be5dc276

16
FAQ.md

@@ -1,6 +1,10 @@
Material Deck is a big and complex module, and requires some setup. If you have any issues, please make sure you've thoroughly read and followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) and [module settings instructions](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup).<br> Material Deck is a big and complex module, and requires some setup. If you have any issues, please make sure you've thoroughly read and followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) and [module settings instructions](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup).<br>
* [I've installed the module, server and Stream Deck plugin, why doesn't it do anything?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#ive-installed-the-module-server-and-stream-deck-plugin-why-doesnt-it-do-anything)
* [Does Material Deck work with hosting services such as the Forge?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#does-material-deck-work-with-hosting-services-such-as-the-forge)
* [My server is secure (using SSL), will Material Deck work?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#my-server-is-secure-using-ssl-will-material-deck-work)
* [How do I know if my server is secure?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#how-do-i-know-if-my-server-is-secure)
* [I get the error that Material Deck cannot connect to Material Server](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#i-get-the-error-that-material-deck-cannot-connect-to-material-server)
# Frequently Asked Questions # Frequently Asked Questions
## I've installed the module, server and Stream Deck plugin, why doesn't it do anything? ## I've installed the module, server and Stream Deck plugin, why doesn't it do anything?
@@ -26,4 +30,12 @@ Alternatively, look at the url (invitation link). If it starts with 'http://' it
## I get the error that Material Deck cannot connect to Material Server ## I get the error that Material Deck cannot connect to Material Server
Make sure that you've followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) closely, including the last section 'Installing Material Server'.<br> Make sure that you've followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) closely, including the last section 'Installing Material Server'.<br>
Make sure Material Server is running, and that you've set up the correct Material Server Address in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup). In most cases, the address should be 'localhost:3001', **not the address of your Foundry server!**<br> Make sure Material Server is running, and that you've set up the correct Material Server Address in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup). In most cases, the address should be 'localhost:3001', **not the address of your Foundry server!**<br>
The only situation where it should be changed is if you're running Material Server on a different machine than the one you're accessing Foundry from. The only situation where it should be changed is if you're running Material Server on a different machine than the one you're accessing Foundry from.
## Does Material Deck work on Windows/OSX/Linus?
#### Windows
As far as I know, there are no reported issues with Windows 10
#### OSX
Some users have reported issues. [This](https://github.com/CDeenen/MaterialDeck/issues/43) might solve your issue, otherwise, please contact me.
#### Linux
Elgato hasn't released an official Stream Deck application for Linux, however there is [streamdeck_ui](https://timothycrosley.com/project-7-streamdeck_ui). There is at least one user who has succesfully used that.