https://github.com/bartdelrue/deno_webmention
https://github.com/bartdelrue/deno_webmention
deno webmention
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bartdelrue/deno_webmention
- Owner: BartDelrue
- License: cc0-1.0
- Created: 2025-01-03T14:48:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T09:39:28.000Z (over 1 year ago)
- Last Synced: 2025-06-08T23:02:23.839Z (about 1 year ago)
- Topics: deno, webmention
- Language: TypeScript
- Homepage: https://bartdelrue.github.io
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Webmention POC
A very rudimentary implementation of the webmention protocol using
deno.
See [W3C Recommendation](https://www.w3.org/TR/webmention/).
## Development
```sh
deno task dev
```
Do not forget to add a `SECRET` variable to the `.env` file and
calculate they correct key for your hostname.
## Usage
### Send a webmention
**POST** a webmention request containing source and target as per the
specification.
Additionally, you need to add the key parameter to the
URLSearchParams.
The key must be equal to the hash of the target's hostname and a
`SECRET` `.env` variable in order to work.
You can use the same key to target multiple pages, as long as they
share the same hostname.
```
POST /?key=...
Content-Type: application/x-www-form-urlencoded
source=[source URL]&target=[target URL]
```
### Get the number of webmentions
**GET** the number of webmentions per hostname by sending a GET
request with the key parameter.
The key must be equal to the hash of the target's hostname and a
`SECRET` `.env` variable in order to work.
There's an optional second **target** parameter to only get the number
of webmentions for a specific target URL.
`GET /?key=...&target=...`
## Storage
This project uses [Deno KV](https://docs.deno.com/deploy/kv/manual/)
for storage, a Deno Key-Value database built directly into the the
Deno runtime.