This is an example for setting up a serverless micropub endpoint. It has been tested and is actively used to publish posts to my site benji.dog by committing code to my repo benjifs/benji using benjifs/micropub and benjifs/github-store.

Clicking the "Deploy to Netlify" button will fork this repository and create a new Netlify site which, after configuration, can be used with any Micropub Client to add content to your site.

When setting this project up on Netlify, you should be asked to configure the following environment variables:

By default, posts will be created under /src/${postType}/${slug}.md where postType matches one of the post types supported by the endpoint. Files will be uploaded to the media endpoint under /uploads. You can change this behavior by changing the value of contentDir and mediaDir in /netlify/config.js.

For additional configuration options, checkout the main project repo.

Send a application/json, x-www-form-urlencoded, or multipart/form-data request to create a post. See 3.6.3 Request.

Can also handle update, delete, and undelete actions.

• 201 on success with a Location header for the URL of the created post.
• 400 an error occurred with approriate error message.
• 401 or 403 if unauthorized or invalid token was provided.

• q=config: Get micropub configuration. See 3.7.1 Configuration.
• q=media-endpoint: Get media endpoint if configured. See 3.6.1 Discovery
• q=post-types: Get supported post types. See discussion about proposed extension.
• q=syndicate-to: Get a list of supported syndication targets. See 3.7.3 Syndication Targets
• q=source&url=: Get properties for post in url. Optionally can also add properties= to only get those properties as the response. See 3.7.2 Source Content.

Send a multipart/form-data request to upload a file. See 3.6.3 Request.

• 201 on success with a Location header for the URL of the uploaded item.
• 400 if no file was uploaded with approriate error message.
• 401 or 403 if unauthorized or invalid token was provided.

• q=source: Get list of most recently uploaded files. Optionally can use offset and limit to implement pagination. See discussion about proposed extension.

The current supported post types are:

• article
• bookmark
• like
• listen
• note
• photo
• play
• read
• repost
• rsvp
• watch
• reply

You can modify which post types are supported by setting the value for post-types in /netlify/config.js.

Note: If a post does not fit under a specific type, it will default to be of type note.

• ME should have a trailing slash
• If you make a change to the environment variables in Netlify, you must redeploy otherwise it will continue using the old variables.

• Micropub spec
• Micropub media endpoint
• Handling a micropub request
• Micropub extensions