Serverless Micropub server that accepts CREATE, UPDATE, and DELETE requests and adds or removes the corresponding files to a repository where your static site lives (Eleventy, Hugo, etc.)
- Deploy to Netlify
- Create a GitHub Personal Access Token
- Set the required Environment Variables
- Configure your site with the Micropub endpoint
<link rel="micropub" href="https://example.com/micropub">
- Use a Micropub Client to authenticate and post to your site.
- The published content should then be added to your repo as a markdown file under the directory:
/CONTENT_DIR/{ type }/wheretypecorresponds to the type of content published. Read more about supported content types.
If your static site's repository is on GitLab, fork this repo instead and change the imports in src/media.js and src/libs/publish.js to gitlab.
Alternatively, the GitLab repo can also be deployed and it should be setup to run with a GitLab repository. No longer updating.
| name | description |
|---|---|
| GIT_TOKEN | GitHub Personal Access Token OR GitLab Personal Access Token |
| GIT_BRANCH | Branch name to add posts to. Must already exist. Required for GitLab, optional for GitHub |
| --- | --- |
| GITHUB_USER | Username for repo where posts are added to |
| GITHUB_REPO | Name of repo where posts are added to |
| --- | --- |
| GITLAB_PROJECT_ID | Project ID for the repo posts are added to |
| --- | --- |
| ME | rel="me" |
| TOKEN_ENDPOINT | Endpoint to validate Token |
| name | description | default |
|---|---|---|
| SYNDICATE_TO | JSON string (single object or array) of syndication targets | [] |
| --- | --- | --- |
| GIT_AUTHOR_EMAIL | Author email for commits |
GIT_TOKEN owner's email |
| GIT_AUTHOR_NAME | Author name for commits |
GIT_TOKEN owner's name |
| --- | --- | --- |
| MEDIA_ENDPOINT | If using an external MEDIA_ENDPOINT. Returned in configuration
|
NETLIFY_URL/.netlify/functions/media |
| CONTENT_DIR | Directory where posts are uploaded to | src |
| MEDIA_DIR | Directory where media is uploaded to | uploads |
| --- | --- | --- |
| PERMANENT_DELETE | If set, a delete action will delete the file from the repo |
File will be "marked" as deleted and the static site generator handles not rendering the file |
| FILENAME_FULL_DATE | If true, filename will have the date prepended in the format YYYY-MM-DD. See Jekyll Posts
|
-
DEBUG: Will preventPOST,PUT, andDELETErequests to go to GitHub or GitLab. Only used for debugging.
The current supported content types are:
-
article -
/CONTENT_DIR/articles/ -
bookmark -
/CONTENT_DIR/bookmarks/ -
like -
/CONTENT_DIR/likes/ -
note -
/CONTENT_DIR/notes/ -
rsvp -
/CONTENT_DIR/rsvp/ -
watch -
/CONTENT_DIR/watched/ -
reply -
/CONTENT_DIR/notes/
Note: If a post does not fit under a specific type, it will default to be of type
note
- create - allows the client to create posts on behalf of the user
- update - allows the client to edit existing posts
- delete - allows the client to delete posts
- undelete - allows the client to undelete posts
- media - allows the client to upload files to the media endpoint
-
GIT_BRANCHshould already exist -
MEshould 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.
- Separate the GitHub and GitLab functions (maybe as their own npm packages)
- Configure to run with either GitHub or GitLab based on the set environment variables