Update Documentation (User Guide)

docs/userguide/index.html

@@ -261,5 +261,5 @@ <h1>User Guide</h1>
 
 <!--
 MkDocs version : 0.16.0
-Build Date UTC : 2017-10-02 05:43:26
+Build Date UTC : 2017-11-06 21:21:04
 -->

docs/userguide/mkdocs/search_index.json

@@ -217,7 +217,7 @@
         }, 
         {
             "location": "/troubleshooting/", 
-            "text": "Installation\n\n\nDuring installation the database tables are being created but some of the data isn't getting inserted.\n\n\nMySQL strict mode may be enabled on your server. In order for DomainMOD to install and run, strict mode must to be disabled.\n\n\nTo disable strict mode you need to edit your MySQL configuration file. In it there will be a line that looks like:\n\n\nsql-mode=\"STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION\"\n\n\n\nTo disable strict mode you need to remove STRICT_TRANS_TABLES from this line (including the comma after it, if there is one), which in this example would leave you with:\n\n\nsql-mode=\"NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION\"\n\n\n\nOnce disabled you will need to restart MySQL, and then DomainMOD should install properly.\n\n\nThe images and CSS are broken or you're receiving an error that there are too many redirects.\n\n\n\nThis is generally caused by an invalid web root in your config.inc.php file. Please double check your config.inc.php file and confirm that the $web_root variable reflects the directory where you installed DomainMOD.\n\n\nFor example, if you access DomainMOD via the URL http://example.com/domains/ the $web_root variable should be:\n\n\n$web_root = \"/domains\"; (don't include a trailing slash!)\n\n\n\nAnd if you've installed DomainMOD in the root folder of a domain or subdomain, the $web_root variable in your config.inc.php file should be blank, like so:\n\n\n$web_root = \"\";\n\n\n\nUpgrading\n\n\nThere was a problem while upgrading and now I can't access DomainMOD.\n\n\nAlthough we personally haven't see this happen yet, it's definitely possible. This is why we recommend you make a backup of your entire DomainMOD database before upgrading (you did make that backup, right?).\n\n\nFollow these steps to restore your copy of DomainMOD:\n\n\n\n\n\n\nRestore your DomainMOD database backup to the same location as your previous DomainMOD database.\n\n\n\n\n\n\nInstead of logging into DomainMOD to upgrade your database, run the below script from the command line.\n\n\n[FULL SERVER PATH TO DOMAINMOD]/update.php\n\n\nThe full command will look something like this, depending on the location of PHP and DomainMOD on your server:\n\n\n/usr/bin/php -f /home/user/www/domainmod/update.php\n\n\n\n\n\n\nIf you receive a notice that your upgrade was \nsuccessful\n, switch back to your web browser and try to login to DomainMOD. If you're able to login successfully you can ignore the rest of these steps.\n\n\n\n\n\n\nIf you receive a notice that your upgrade was \nunsuccessful\n, keep a record of any error messages that are displayed and proceed to the next step.\n\n\n\n\n\n\nRestore your DomainMOD database backup again, then \ndownload the previous version that you were using\n and go through the standard installation steps, pointing it at your newly-restored database in the config.inc.php file. This should get you back to where you were before you tried upgrading.\n\n\n\n\n\n\nContact us with any error messages that were displayed and we'll try to help figure out what went wrong with your upgrade.\n\n\n\n\n\n\nUsage\n\n\nDomainMOD seems to be working properly, but when I use the software I get a bunch of warning messages, such as \"undefined index\" and \"undefined variable\".\n\n\nThis is related to the error reporting level that you have turned on in PHP. Although these are only warnings and won't actually be breaking anything, you can get rid of them by editing your php.ini file and changing the error_reporting line.\n\n\nRight now you probably have something that looks like this:\n\n\nerror_reporting = E_ALL\n\n\n\nBut you should have something that looks like this:\n\n\nerror_reporting = E_ALL \n ~E_NOTICE \n ~E_STRICT \n ~E_DEPRECATED\n\n\n\nCommented out in your php.ini file, above the error_reporting directive, there may be a suggested error reporting line for a \"Production\" environment. Try using that line instead of what you're using now, restart Apache/PHP, and that should get rid of the errors.\n\n\nI'm trying to connect DomainMOD to my domain registrar account using the API so that I can import my domains, but everything in the Domain Queue just says \"Pending\".\n\n\n\nIn order to import your domains using the domain registrar's API you must setup the \ncron job\n that comes with DomainMOD. In addition to having the cron job running, you must also have your API credential saved along with your registrar account Asset.\n\n\nI've setup the Data Warehouse within DomainMOD, but none of my changes propagate to my web server.\n\n\n\nThe Data Warehouse is read-only. You can import data from your web server into your Data Warehouse, but this data is for informational purposes only, and you can't edit your server data within DomainMOD and have it update your web server. This is something that will be worked on in the future, but is currently not possible.\n\n\nI'm getting the error, \"Database Connection Error: 1045\".\n\n\n\nError 1045 is an access denied error, which seems to be caused when the user doesn't have appropriate permissions on the database, or there's another privilege issue with the database. Unfortunately this is pretty difficult to troubleshoot on our end, as there are many things that can cause this.\n\n\nWe would recommend trying some of the suggestions for this error in Google and see if any of them help: \nhttps://www.google.com/search?q=Database+Connection+Error%3A+1045\n.\n\n\nI'm trying to import data using the Domain Queue, but everything is stuck on \"Processing\".\n\n\n\nIn case there's a problem with the cron job you can also try triggering the queue manually. Go to Administration -\n Task Scheduler, and then beside \"Domain Queue Processing\" click the \"run now\" link (this may take a bit of time to run). Then go back to the queue and see if anything has changed.\n\n\nIf that doesn't work you can try clearing the queue items that are currently processing by going to Administration -\n Maintenance, and then clicking on \"Clear Queue Processing\". Now try the last suggestion again to see if running the queue manually through the Task Scheduler helps.\n\n\nIf that still doesn't do it go to Administration -\n Maintenance, and then click on \"Clear Queues\". This will completely clear out the queue. Now try retrieving your data again using the Domain Queue.\n\n\nDebugging\n\n\nIf you're still having problems you can enable Debugging Mode, which will make DomainMOD start logging your actions and errors. This can help us troubleshoot your issue.\n\n\n\n\nNote\n\n\nNo sensitive information gets stored in the logs. Passwords, API keys, and other sensitive information is replaced with asterisks, so we will never be able to view your private data.\n\n\n\n\nTo enable Debugging Mode:\n\n\n\n\n\n\nClick \nAdministration\n on the main menu, then click \nSystem Settings\n.\n\n\n\n\n\n\nChange the \nDebugging Mode\n option to \nEnabled\n.\n\n\n\n\n\n\nClick the \nUpdate System Settings\n button.\n\n\n\n\n\n\nOnce debugging is enabled use DomainMOD as you normally would, repeating the steps you took when you first encountered a problem. Once you've done this follow the steps below to report your issue.\n\n\n\n\n\n\nIf you haven't already, visit the DomainMOD support forum and post about your issue: \nhttps://domainmod.org/forum/\n\n\n\n\n\n\nIn DomainMOD, click on \nAdministration\n and then \nDebug Log\n.\n\n\n\n\n\n\nClick the \nExport\n button to export the debugging log.\n\n\n\n\n\n\nSend an email to \ndebugging@domainmod.org\n and attach the log file that you just exported, and also include a link to your forum post.\n\n\n\n\n\n\nWe will review your debugging log and get back to you as soon as we can!\n\n\nAlso, if you haven't already, make sure you disable Debugging Mode.", 
+            "text": "Installation\n\n\nI get a blank page and can't go any further OR I get an Error 500 OR The database tables are being created but some of the data isn't getting inserted.\n\n\nMySQL strict mode may be enabled on your server. In order for DomainMOD to install and run, strict mode must to be disabled.\n\n\nTo disable strict mode you need to edit your MySQL configuration file. In it there will be a line that looks like:\n\n\nsql-mode=\"STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION\"\n\n\n\nTo disable strict mode you need to remove STRICT_TRANS_TABLES from this line (including the comma after it, if there is one), which in this example would leave you with:\n\n\nsql-mode=\"NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION\"\n\n\n\nOnce disabled you will need to restart MySQL, and then DomainMOD should install properly.\n\n\nThe images and CSS are broken or you're receiving an error that there are too many redirects.\n\n\n\nThis is generally caused by an invalid web root in your config.inc.php file. Please double check your config.inc.php file and confirm that the $web_root variable reflects the directory where you installed DomainMOD.\n\n\nFor example, if you access DomainMOD via the URL http://example.com/domains/ the $web_root variable should be:\n\n\n$web_root = \"/domains\"; (don't include a trailing slash!)\n\n\n\nAnd if you've installed DomainMOD in the root folder of a domain or subdomain, the $web_root variable in your config.inc.php file should be blank, like so:\n\n\n$web_root = \"\";\n\n\n\nUpgrading\n\n\nThere was a problem while upgrading and now I can't access DomainMOD.\n\n\nAlthough we personally haven't see this happen yet, it's definitely possible. This is why we recommend you make a backup of your entire DomainMOD database before upgrading (you did make that backup, right?).\n\n\nFollow these steps to restore your copy of DomainMOD:\n\n\n\n\n\n\nRestore your DomainMOD database backup to the same location as your previous DomainMOD database.\n\n\n\n\n\n\nInstead of logging into DomainMOD to upgrade your database, run the below script from the command line.\n\n\n[FULL SERVER PATH TO DOMAINMOD]/update.php\n\n\nThe full command will look something like this, depending on the location of PHP and DomainMOD on your server:\n\n\n/usr/bin/php -f /home/user/www/domainmod/update.php\n\n\n\n\n\n\nIf you receive a notice that your upgrade was \nsuccessful\n, switch back to your web browser and try to login to DomainMOD. If you're able to login successfully you can ignore the rest of these steps.\n\n\n\n\n\n\nIf you receive a notice that your upgrade was \nunsuccessful\n, keep a record of any error messages that are displayed and proceed to the next step.\n\n\n\n\n\n\nRestore your DomainMOD database backup again, then \ndownload the previous version that you were using\n and go through the standard installation steps, pointing it at your newly-restored database in the config.inc.php file. This should get you back to where you were before you tried upgrading.\n\n\n\n\n\n\nContact us with any error messages that were displayed and we'll try to help figure out what went wrong with your upgrade.\n\n\n\n\n\n\nUsage\n\n\nDomainMOD seems to be working properly, but when I use the software I get a bunch of warning messages, such as \"undefined index\" and \"undefined variable\".\n\n\nThis is related to the error reporting level that you have turned on in PHP. Although these are only warnings and won't actually be breaking anything, you can get rid of them by editing your php.ini file and changing the error_reporting line.\n\n\nRight now you probably have something that looks like this:\n\n\nerror_reporting = E_ALL\n\n\n\nBut you should have something that looks like this:\n\n\nerror_reporting = E_ALL \n ~E_NOTICE \n ~E_STRICT \n ~E_DEPRECATED\n\n\n\nCommented out in your php.ini file, above the error_reporting directive, there may be a suggested error reporting line for a \"Production\" environment. Try using that line instead of what you're using now, restart Apache/PHP, and that should get rid of the errors.\n\n\nI'm trying to connect DomainMOD to my domain registrar account using the API so that I can import my domains, but everything in the Domain Queue just says \"Pending\".\n\n\n\nIn order to import your domains using the domain registrar's API you must setup the \ncron job\n that comes with DomainMOD. In addition to having the cron job running, you must also have your API credential saved along with your registrar account Asset.\n\n\nI've setup the Data Warehouse within DomainMOD, but none of my changes propagate to my web server.\n\n\n\nThe Data Warehouse is read-only. You can import data from your web server into your Data Warehouse, but this data is for informational purposes only, and you can't edit your server data within DomainMOD and have it update your web server. This is something that will be worked on in the future, but is currently not possible.\n\n\nI'm getting the error, \"Database Connection Error: 1045\".\n\n\n\nError 1045 is an access denied error, which seems to be caused when the user doesn't have appropriate permissions on the database, or there's another privilege issue with the database. Unfortunately this is pretty difficult to troubleshoot on our end, as there are many things that can cause this.\n\n\nWe would recommend trying some of the suggestions for this error in Google and see if any of them help: \nhttps://www.google.com/search?q=Database+Connection+Error%3A+1045\n.\n\n\nI'm trying to import data using the Domain Queue, but everything is stuck on \"Processing\".\n\n\n\nIn case there's a problem with the cron job you can also try triggering the queue manually. Go to Administration -\n Task Scheduler, and then beside \"Domain Queue Processing\" click the \"run now\" link (this may take a bit of time to run). Then go back to the queue and see if anything has changed.\n\n\nIf that doesn't work you can try clearing the queue items that are currently processing by going to Administration -\n Maintenance, and then clicking on \"Clear Queue Processing\". Now try the last suggestion again to see if running the queue manually through the Task Scheduler helps.\n\n\nIf that still doesn't do it go to Administration -\n Maintenance, and then click on \"Clear Queues\". This will completely clear out the queue. Now try retrieving your data again using the Domain Queue.\n\n\nForm fields aren't displaying properly, such as checkboxes and text fields showing as empty boxes.\n\n\n\nThis is caused by JavaScript being disabled in your web browser. If enabling JavaScript doesn't fix the issue try disabling any ad blockers or other content blockers you may have installed.\n\n\nDebugging\n\n\nIf you're still having problems you can enable Debugging Mode, which will make DomainMOD start logging your actions and errors. This can help us troubleshoot your issue.\n\n\n\n\nNote\n\n\nNo sensitive information gets stored in the logs. Passwords, API keys, and other sensitive information is replaced with asterisks, so we will never be able to view your private data.\n\n\n\n\nTo enable Debugging Mode:\n\n\n\n\n\n\nClick \nAdministration\n on the main menu, then click \nSystem Settings\n.\n\n\n\n\n\n\nChange the \nDebugging Mode\n option to \nEnabled\n.\n\n\n\n\n\n\nClick the \nUpdate System Settings\n button.\n\n\n\n\n\n\nOnce debugging is enabled use DomainMOD as you normally would, repeating the steps you took when you first encountered a problem. Once you've done this follow the steps below to report your issue.\n\n\n\n\n\n\nIf you haven't already, visit the DomainMOD support forum and post about your issue: \nhttps://domainmod.org/forum/\n\n\n\n\n\n\nIn DomainMOD, click on \nAdministration\n and then \nDebug Log\n.\n\n\n\n\n\n\nClick the \nExport\n button to export the debugging log.\n\n\n\n\n\n\nSend an email to \ndebugging@domainmod.org\n and attach the log file that you just exported, and also include a link to your forum post.\n\n\n\n\n\n\nWe will review your debugging log and get back to you as soon as we can!\n\n\nAlso, if you haven't already, make sure you disable Debugging Mode.", 
             "title": "Troubleshooting"
         }, 
         {

docs/userguide/sitemap.xml

@@ -4,111 +4,111 @@
 
     <url>
      <loc>/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/getting-started/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/first-run/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/upgrading/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/creating-assets/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/adding-domains/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/domain-queue/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/bulk-updater/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/administration/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/data-warehouse/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/faq/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/troubleshooting/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/contribute/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>
 
 
 
     <url>
      <loc>/support/</loc>
-     <lastmod>2017-10-01</lastmod>
+     <lastmod>2017-11-06</lastmod>
      <changefreq>daily</changefreq>
     </url>