Skip to content

appfog/patchwork-thread

 
 

Repository files navigation

Thread

Thread is the data access and update piece of Patchwork.

You use Thread by pointing it at a content repository in GitHub like this one. It then grabs each markdown file, parses it, and updates a database and (optionally) an IndexTank API-compatible search index. It will also optionally upload assets to an Amazon S3 bucket.

You can also set a post-receive webhook for a content repo on GitHub so that Thread will keep your database, search index, and S3 bucket whenever you commit changes to the content repo.

Usage

Note: The canonical deployment for Patchwork is on AppFog.

1. Clone this repo.

2. Copy the config.yml.example file to config.yml.

$ cp config.yml.example config.yml

3. Modify config.yml to point at your content repo.

4. Push to AppFog.

$ npm install # Use a 0.8 version of NodeJS
$ af push patchwork-thread

5. Create and bind a new MongoDB service to the new app.

$ af create-service mongodb --name joebadmo-patchwork --bind patchwork-thread

6. Add environment variables for your various credentials.

$ af env-add patchwork-thread GITHUB_PASSWORD="FakePass1"
$ af env-add patchwork-thread S3_ACCESS_KEY="RANDOMSTRING"
$ af env-add patchwork-thread S3_SECRET="RANDOMSTRING"
$ af env-add patchwork-thread SEARCHIFY_PRIVATE_API_URL="http://:password@something.api.searchify.com"

7. Index your content repo.

$ curl patchwork-thread.aws.af.cm/index/all/joebadmo/patchwork

8. Now set up your Quilt.

About

A way to get things on the web.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%