Indiekit is a small but powerful server that acts as the go-between your website and the wider independent web.
-
Publish content to your website using apps like iAWriter, Micro.blog, Icro, Indigenous or services that support the Micropub API
-
Syndicate your content to social networks like Twitter,
Mastodon and LinkedIn, and save posts to the Internet Archive -
Accept likes, comments and other types of feedback on your content with Webmention -
Save files to different content stores such as Bitbucket, GitHub, GitLab and Gitea
-
Highly configurable, with presets available for common static site generators such as Jekyll and Hugo.
-
Localisable, with initial support for English, French and German.
- Create, update and delete posts
- Upload files
- Configure different post types
- Accept post status and visibility
- Review previously published posts and files
- Bookmarklet to save and share bookmarks
- Publish to different content stores
- Support for popular static site generators (Jekyll, Hugo, 11ty)
- Localised to different languages
Plug-in API
- Node.js v16+
npm install @indiekit/indiekit
Learn how to set up an Indiekit server and view an example server configuration.
If you want to see how Indiekit works, deploy this application to Heroku.
This assumes you’ll be saving files to GitHub and publishing to a Jekyll (or similar) static site generator.
Clicking the button below will guide you through the process.
You’ll be asked to provide the following values:
GITHUB_TOKEN- A GitHub personal access tokenGITHUB_USER- Your username on GitHubGITHUB_REPO- Name of the repository where you want to save filesPUBLICATION_URL- URL of the website you want to publish to
npm startIf you’re developing a new feature, and want the application to automatically restart whenever a file change is detected, use npm run dev.
npm testThe following environment variables need to be set before running tests:
TEST_PUBLICATION_URLTEST_BEARER_TOKENTEST_BEARER_TOKEN_NOSCOPE
TEST_BEARER_TOKEN and TEST_BEARER_TOKEN_NOSCOPE provide IndieAuth access tokens whose me value matches that set in TEST_PUBLICATION_URL.TEST_BEARER_TOKEN should provide scoped permissions create update delete, whereas TEST_BEARER_TOKEN_NOSCOPE should provide no permissions at all.
Homebrew Access Token is a useful tool for creating access tokens for this purpose.
Architectural decisions made on this project are documented using Architecture Decision Records, as described by Michael Nygard. These can be found in /docs/decisions.
Developed by Paul Robert Lloyd.
Thank-you to Aron Carroll for mentoring me during the development of this project. Indiekit is a much better project for his feedback and advice.
Indiekit is inspired by similar projects made by members of the IndieWeb community, all of which you are encouraged to try: