From 7b53048a91f99ca17027e581a6bbbd4a3f72b20a Mon Sep 17 00:00:00 2001 From: David Erwin Date: Thu, 13 Jul 2017 12:04:18 -0400 Subject: [PATCH] Add install troubleshooting doc --- docs/_data/sidebars/talk_sidebar.yml | 7 ++++++- docs/install-troubleshooting.md | 22 ++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 docs/install-troubleshooting.md diff --git a/docs/_data/sidebars/talk_sidebar.yml b/docs/_data/sidebars/talk_sidebar.yml index 62660783c8..02cac9f3fe 100644 --- a/docs/_data/sidebars/talk_sidebar.yml +++ b/docs/_data/sidebars/talk_sidebar.yml @@ -36,6 +36,9 @@ entries: - title: Setup url: /install-setup.html output: web + - title: Troubleshooting + url: /install-troubleshooting.html + output: web - title: Architecture output: web @@ -46,11 +49,13 @@ entries: - title: Tags url: /architecture-tags.html output: web + - title: Metadata API + url: /architecture-metadata.html + output: web - title: cli url: /architecture-cli.html output: web - - title: Plugins output: web folderitems: diff --git a/docs/install-troubleshooting.md b/docs/install-troubleshooting.md new file mode 100644 index 0000000000..6ff42af059 --- /dev/null +++ b/docs/install-troubleshooting.md @@ -0,0 +1,22 @@ +--- +title: Installation Troubleshooting +keywords: install +sidebar: talk_sidebar +permalink: install-troubleshooting.html +summary: +--- + +This page tracks common issues that arise when installing Talk and provides resolutions. + +## The Talk server seems to be working but the stream isn't showing up on my page. + +Talk employs a _domain whitelist_ that controls which sites can contain comment threads. This prevents malicious folks from using your server to embed streams on unwanted pages. + +If your comment thread isn't showing: + +1. Log into your admin panel +1. Go to the Configure tab +1. Select the Tech Settings submenu +1. Ensure that your Domain is the Permitted Domains list + +Note: if your site has multiple subdomains, listing the domain itself (ie: `mydomain.com`) will enable Talk on all subdomains. If you would like to restrict Talk to certain subdomains, you must list all of them here (ie: `thisone.mydomain.com thatone.mydomain.com`).