micropub-endpoint

KO | EN

gitlite — search

#javascript #python #go #android #rust #deep-learning #docker #macos #windows #awesome #cli #mcp #openai #open-source

micropub-endpoint

(★ 30)

Receives requests.

micropub-endpoint Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Micropub endpoint

Used by [`muan/micropub-content`](https://github.com/muan/micropub-content).

## Use

### 1. Micropub server

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/muan/micropub-endpoint/tree/main)

This server will attempt to create content for a Jekyll site.

### 2. Jekyll site

To create a Jekyll site from a template:

1. Fork [`muan/micropub-content`](https://github.com/muan/micropub-content).

2. Edit `_config.yml` with your info.

- `micropub_endpoint`: URL of the Heroku app you just deployed, likely `https://[app-name].herokuapp.com`.
  - `url`: GitHub pages URL of the repository you just forked, likely `https://[github-username].github.io/micropub-content`.

The Jekyll site might take a minute to build. Once it's built, you can head to [https://micropub-client.herokuapp.com/](https://micropub-client.herokuapp.com/) and log in with your site URL to create your first post. It comes with a `feed.rss` that you can use for [micro.blog](https://micro.blog/).

---

## Details

To publish a post through this implementation of Micropub flow, it requires the following:

1. `GitHub` as the authentication provider.
2. `GitHub` and its API for interacting with the repository for your blog content.
3. `Micropub endpoint`[[template]](https://github.com/muan/micropub-endpoint) that handles sending a request to GitHub.
4. `Micropub client`[[template]](https://github.com/muan/micropub-client) [[hosted]](https://micropub-client.herokuapp.com/) that handles authenticating and sending a request to the endpoint. There are many other Micropub clients that follow the same spec and can be used  here. For example, [Quill](https://quill.p3k.io/).
5. `IndieAuth for GitHub` for handling authentication requests between GitHub and Micropub client.
6. `Micropub content`[[template]](https://github.com/muan/micropub-content) [[demo]](https://muan.github.io/micropub-content/), in this case, your GitHub Pages site.

Out of these 6 items, you would create just 2: the `Mircopub endpoint`, so that you can customize _where_ the post is created and _how_ it is created, and `Mircopub content`, so that you can customize how the GitHub Pages site looks.

Flow:

1. User (you) visits `Micropub client` and log in with your website. In this example, it should be the `Micropub content` Pages site. But it can be a different website as long as it has [these lines](https://github.com/muan/micropub-content/blob/f558b7124c6de6d3da2b1a83b892590ed6853691/_layouts/default.html#L9-L10).
2. `Micropub client` sends a GET request to your website to retrieve your preferred auth endpoints.
3. `Micropub client` redirects you to that endpoint, in this case `IndieAuth for GitHub`, which is a service hosted on Heroku whose sole purpose is to talk to GitHub API and create an access token.
4. Once an access token is obtained, `Micropub client` presents you with text areas for you to create your blog post with.
5. When you submit the post content, `Micropub client` sends the payload to `Micropub endpoint`.
6. `Micropub endpoint` uses sends a request to GitHub with this payload, and create a file in the repository you set in `app.json`.
7. GitHub receives the request and creates a file.
8. GitHub Pages service rebuild your Jekyll site.
9. Your new post is live.

micropub-endpoint

micropub-endpoint Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

micropub-endpoint

micropub-endpoint Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README