diff --git a/docs/source/01-01-talk-quickstart.md b/docs/source/01-01-talk-quickstart.md index 8478ed0f2..6c5ecb5d1 100644 --- a/docs/source/01-01-talk-quickstart.md +++ b/docs/source/01-01-talk-quickstart.md @@ -187,8 +187,10 @@ and walk through the initial setup steps. * First, enter your **Organization Name** and **Organization Contact Email**. This will appear in emails when inviting new team members. * Next, create your Admin user. You can specify an **Email Address**, **Username**, and **Password** + * Finally, enter your list of **Permitted Domains**, read [here](/talk/configuring-talk/#permitted-domains) about whitelisting domains + _During development, ensure you whitelist 127.0.0.1:3000 otherwise the [http://127.0.0.1:3000/](http://127.0.0.1:3000/) page will not load._ @@ -220,6 +222,17 @@ Once you have added the domain of these docs, you can click the button below.
+### Developer Endpoints + +With your local instance of Talk running in development mode (env variable `NODE_ENV=development`) you should now also be able to access the following developer routes: + +* [http://127.0.0.1:3000/dev](http://127.0.0.1:3000/dev]) provides a sample comment stream + +* [http://127.0.0.1:3000/dev/assets](http://127.0.0.1:3000/dev/assets]) provides a list of all stories in Talk and can generate new sample assets + +### Conclusion At this point you've successfully installed, configured, and ran your very own instance of Talk! Continue through this documentation on this site to learn more on how to configure, develop with, and contribute to Talk! + + diff --git a/docs/source/01-03-installation-from-source.md b/docs/source/01-03-installation-from-source.md index 9f4b96d93..978ffedd0 100644 --- a/docs/source/01-03-installation-from-source.md +++ b/docs/source/01-03-installation-from-source.md @@ -70,5 +70,7 @@ You can now start the application by running: yarn watch:server ``` +If you are developing a custom plugin you can use `yarn watch:client` or `yarn watch` to run both client and server. + At this stage, you should refer to the [configuration](/talk/configuration/) for configuration variables that are specific to your installation. diff --git a/docs/source/01-05-pre-launch-checklist.md b/docs/source/01-05-pre-launch-checklist.md index d30419e01..854ead062 100644 --- a/docs/source/01-05-pre-launch-checklist.md +++ b/docs/source/01-05-pre-launch-checklist.md @@ -23,11 +23,13 @@ permalink: /pre-launch-checklist/ - [ ] Do you need to migrate comments from a legacy system? We currently support Disqus, Livefyre, and Civil Comments. - Use the [Talk Import](https://github.com/coralproject/talk-importer) framework - + - [ ] Do you want to provide single sign-on (SSO) by integrating with an external auth system? - See [Authenticating with Talk](/talk/integrating/authentication/) +- [ ] Do you want to integrate Talk with your CMS to automate embedding Talk Comment Stream into your site? + - See [Asset Management](/talk/integrating/asset-management/) - [ ] Do you want to use Social sign-on? - Facebook diff --git a/docs/source/03-02-product-guide-commenter-features.md b/docs/source/03-02-product-guide-commenter-features.md index 3d60eeda9..c89e018e7 100644 --- a/docs/source/03-02-product-guide-commenter-features.md +++ b/docs/source/03-02-product-guide-commenter-features.md @@ -5,13 +5,15 @@ permalink: /commenter-features/ ## Signing up for Talk -There are 2 ways that newsrooms can support signup/login functionality with Talk: +There are 3 ways that newsrooms can support signup/login functionality with Talk: * Use Talk’s auth plugin out of the box (supports account registration with username and password, as well as features like forgot password) +* Use 3rd party authentication provider such as FaceBook or Google. We provide plugins that support logging in with either [Facebook](/talk/plugin/talk-plugin-facebook-auth/) +or [Google](/talk/plugin/talk-plugin-google-auth/). (Note: you must provide your own Facebook App ID and Secret, which you can read more about here: [https://developers.facebook.com](https://developers.facebook.com)) + * Create their own auth plugin to integrate with your own auth systems -We also provide a Facebook auth plugin that supports logging in with Facebook (you must provide your own Facebook App ID and Secret, which you can read more about here: [https://developers.facebook.com](https://developers.facebook.com)) ## Comments and Replies diff --git a/docs/source/integrating/asset-management.md b/docs/source/integrating/asset-management.md index 52bb11b69..190b67c63 100644 --- a/docs/source/integrating/asset-management.md +++ b/docs/source/integrating/asset-management.md @@ -18,6 +18,7 @@ By default, Talk will use "Lazy Asset Creation" to dynamically generate Assets in Talk in order to make it easier for lighter installations. In order to have more strict control over this flow, we will create a plugin that will: + 1. Disable "Lazy Asset Creation" by [Overriding a Resolver](#overriding-a-resolver). 2. Create Assets from our CMS by [Creating a New Asset Route](#creating-a-new-asset-route). 3. Facilitate updates from our CMS to keep Talk in sync by [Creating an Asset Update Route](#creating-an-asset-update-route). @@ -248,7 +249,7 @@ module.exports = router => { }; ``` -As you can see from the previous step of [Creating a New Asset Route](#creating-a-New-Asset-Route) +As you can see from the previous step of [Creating a New Asset Route](#Creating%20a%20New%20Asset%20Route) , we have added the new `PUT` route to the router. This is a simple addition that allows your CMS to call into Talk when the asset has updated it's title, it's url (or really anything in the [AssetSchema](https://github.com/coralproject/talk/blob/master/models/asset.js)) to keep the Talk Admin and links up to date. diff --git a/docs/source/integrating/authentication.md b/docs/source/integrating/authentication.md index 77315a9d8..f834f3e53 100644 --- a/docs/source/integrating/authentication.md +++ b/docs/source/integrating/authentication.md @@ -3,8 +3,10 @@ title: Authenticating with Talk permalink: /integrating/authentication/ --- -You can integrate Talk with any external authentication service that will enable -seamless single sign-on for users within your organization. There are a few +Out of the box Talk supports account registration with username and password, as well as features like forgot password. + +You can also integrate Talk with any external authentication service that will enable +seamless single sign-on (SSO) for users within your organization. There are a few methods of doing so: 1. Passport Middleware @@ -17,8 +19,12 @@ choice. You would choose the **Passport Middleware** route when you are OK using an auth that is triggered from inside Talk that is not connected to an external auth -state (you don't use the auth anywhere else now). A great example of this is our -[talk-plugin-facebook-auth](/talk/plugin/talk-plugin-facebook-auth/) plugin. +state (you don't use the auth anywhere else now). + +Plugins are available for the following 3rd party authentication providers: + +* [Facebook](/talk/plugin/talk-plugin-facebook-auth/) +* [Google](/talk/plugin/talk-plugin-google-auth/) ## Custom Token Integration diff --git a/docs/source/plugins/overview.md b/docs/source/plugins/overview.md index 2e8a9c2a5..1f734edeb 100644 --- a/docs/source/plugins/overview.md +++ b/docs/source/plugins/overview.md @@ -105,6 +105,8 @@ Then the application can be started as is. ### Docker +To deploy customized plugins to a production instance of Talk, we recommend using the Docker onbuild strategy outlined below. + If you deploy using Docker, you can extend from the `*-onbuild` image, an example `Dockerfile` for your project could be: @@ -112,14 +114,22 @@ example `Dockerfile` for your project could be: FROM coralproject/talk:4.5-onbuild ``` -Where the directory for your instance would contain a `plugins.json` file -describing the plugin requirements and a `plugins` directory containing any +Establish a private repository for your instance that includes the following: + +* a `plugins.json` file +listing the plugin requirements +* a `plugins` directory containing any other local plugins that should be included. +* a Dockerfile as outlined above + +Git submodules can also be used to point to plugin directories that might be outside your primary repository. Onbuild triggers will execute when the image is building with your custom configuration and will ensure that the image is ready to use by building all assets inside the image as well. +Once built, you can deploy the docker image to your architecture by tagging the image and including it in your docker-compose.yml. + For more information on the onbuild image, refer to the [Installation from Docker](/talk/installation-from-docker/) documentation.