https://github.com/fedikit/aoba

🍃 Fediverse Integration for Lume & Hono.
https://github.com/fedikit/aoba

activitypub deno fedikit fediverse host-meta nodeinfo webfinger

Last synced: 24 days ago
JSON representation

🍃 Fediverse Integration for Lume & Hono.

• Host: GitHub
• URL: https://github.com/fedikit/aoba
• Owner: fedikit
• License: mit
• Created: 2023-11-16T15:26:53.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-02-06T14:21:23.000Z (9 months ago)
• Last Synced: 2024-09-30T06:41:32.428Z (about 1 month ago)
• Topics: activitypub, deno, fedikit, fediverse, host-meta, nodeinfo, webfinger
• Language: TypeScript
• Homepage: https://deno.land/x/aoba
• Size: 36.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Aoba

[![deno.land/x/aoba](https://shield.deno.dev/x/aoba)](https://deno.land/x/aoba)

![deno compatibility](https://shield.deno.dev/deno/^1.38)

🍃 Fediverse Integration for Lume & Hono.

## Setup

Add Aoba to your `deno.json` or `import_map.json` (replace `{{version}}` with

the current version):

```json

{

  "imports": {

    "aoba/": "https://deno.land/x/aoba@v{{version}}/"

  }

}

```

## [Lume Integration](/lume/)

### [NodeInfo](/lume/plugins/nodeinfo.ts)

Set up static nodeinfo for your site.

```ts

import nodeinfo from 'aoba/lume/plugins/nodeinfo.ts'

site.use(nodeinfo())

```

### [Webfinger](/lume/plugins/webfinger.ts)

Set up static webfinger for your site.

```ts

import webfinger from 'aoba/lume/plugins/webfinger.ts'

site.use(webfinger())

```

### [Headers](/lume/plugins/headers.ts)

Set up `_headers` file for your site. (Netlify and Cloudflare Pages)

```ts

import headers from 'aoba/lume/plugins/headers.ts'

site.use(headers())

```

### [Redirects](/lume/plugins/redirects.ts)

Set up `_redirects` file for your site. (Netlify and Cloudflare Pages)

```ts

import redirects from 'aoba/lume/plugins/redirects.ts'

site.use(redirects())

```

## Hatsu Integration

> Hatsu Integration is consistent with the latest version of Hatsu, so it does

> not follow semver.

For [Hatsu](https://github.com/importantimport/hatsu) users.

### [Lume Plugin](/lume/plugins/hatsu.ts)

Copy the `.well-known/*` file from the Hatsu instance and set the link alternate

for matched page.

```ts

import hatsuPlugin from 'aoba/lume/plugins/hatsu.ts'

site.use(

  hatsuPlugin({

    instance: new URL('https://hatsu.local'),

  }),

)

```

### [Lume Server Middleware](/lume/middlewares/hatsu.ts)

Redirecting `.well-known/*` and `activity+json` requests.

```ts

import hatsuMiddleware from 'aoba/lume/middlewares/hatsu.ts'

server.use(

  hatsuMiddleware({

    instance: new URL('https://hatsu.local'),

    location: site.options.location,

  }),

)

```

### [Hono Server Middleware](/hono/middlewares/hatsu.ts)

Redirecting `.well-known/*` and `activity+json` requests.

```ts

import { hatsuObject, hatsuWellKnown } from 'aoba/hono/middlewares/hatsu.ts'

const instance = new URL('https://hatsu.local')

app.use('/.well-known/*', hatsuWellKnown({ instance }))

app.use('/posts/*', hatsuObject({ instance }))

```

## License

Licensed under [MIT](LICENSE.md).