Created FAQ (markdown)
29
FAQ.md
Normal file
29
FAQ.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Frequently Asked Questions
|
||||||
|
## I've installed the module, server and Stream Deck plugin, why doesn't it do anything?
|
||||||
|
Did you enable the module in 'Manage Modules'?<br>
|
||||||
|
Did you enable the module in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup)?
|
||||||
|
|
||||||
|
## Does Material Deck work with hosting services such as the Forge?
|
||||||
|
Yes it does! Please see below for information on connecting to secured servers.
|
||||||
|
|
||||||
|
## My server is secure (using SSL), will Material Deck work?
|
||||||
|
It will work, but there are a few caveats:<br>
|
||||||
|
-Material Server will need to run on your local machine (so on the computer you're using Foundry on)<br>
|
||||||
|
-You must set 'Material Server Address' in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup) to 'localhost:3001'.<br>
|
||||||
|
<br>
|
||||||
|
A secure version of Material Server is planned.
|
||||||
|
|
||||||
|
## How do I know if my server is secure?
|
||||||
|
If you're self-hosting, the Foundry server is not secure by default. If it is hosted remotely it is.<br>
|
||||||
|
To check:<br>
|
||||||
|
Access Foundry from a browser. For most (or all) browsers: On the left of the address bar you'll either see a closed lock (server is secure), a lock with a red line through it (server is not secure), or the text 'not secure' (server is not secure).<br>
|
||||||
|
Alternatively, look at the url (invitation link). If it starts with 'http://' it is not secure, if it starts with 'https://' it is secure.
|
||||||
|
|
||||||
|
## 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 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.
|
||||||
Reference in New Issue
Block a user