mastofeed-iframe-embed/README.md

# Mastofeed

Embed a mastodon feed in your blog et cetera.

https://www.mastofeed.com

## User guide

The homepage has a tool for generating iframe code for you, with a sensible `sandbox` attribute.  The feeds fit comfortably in a 400px wide area.

## API

### V2

#### GET `/apiv2/feed`

> example: `/api/feed?userurl=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67&scale=90&theme=light`

Returns a html page which displays a mastodon feed for a user URL.  Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67')` ).

Querystring options:

| option | required | description |
| ------ | -------- | ----------- |
| `userurl` | **yes** | Mastodon/ActivityPub account URL (usually `https://${instance}/users/${username}`) |
| `feedurl` | no | a URL to a page of an ActivityPub post collection. Only used for pages beyond the first. |
| `theme` | no | either `dark`, `light` or `auto`, to select the UI theme (default is `dark`). `auto` will appear light unless the user sets up dark mode on their device. |
| `boosts` | no | whether to show boosts or not |
| `replies` | no | whether to show replies or not |
| `size` | no | the scale of the UI in percent. |

### V1 (deprecated, will now just redirect you to the v2 API)

#### GET `/api/feed`

> example: `/api/feed?url=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67.atom&scale=90&theme=light`

Returns a html page which displays a mastodon feed for an atom feed URL.  Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67.atom')` ).

Querystring options:


| option | required | description |
| ------ | -------- | ----------- |
| `url` | **yes** | Mastodon Atom feed URL |
| `theme` | no | either dark, light or auto, to select the UI theme (default is dark). `auto` will appear light unless the user sets up dark mode on their device. |
| `size` | no | the scale of the UI in percent. |

## Server Installation

This is a straightforward node project with zero databases or anything, you should just be able to run `npm install` and then `npm start` to get up and running.  Set your `PORT` environment variable to change the port it listens on.

## Improve me

Feel free to add a chaching layer, improve the styles and add more features.
Create README.md 2017-04-30 20:03:49 +02:00			`# Mastofeed`

			`Embed a mastodon feed in your blog et cetera.`

Update README.md 2017-05-01 03:12:27 +02:00			`https://www.mastofeed.com`
Update README.md 2017-04-30 20:26:13 +02:00
Update README.md 2017-04-30 22:07:01 +02:00			`## User guide`
Create README.md 2017-04-30 20:03:49 +02:00
			The homepage has a tool for generating iframe code for you, with a sensible `sandbox` attribute. The feeds fit comfortably in a 400px wide area.

			`## API`

document v2 API 2019-08-02 19:33:03 +02:00			`### V2`

			#### GET `/apiv2/feed`

			> example: `/api/feed?userurl=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67&scale=90&theme=light`

			Returns a html page which displays a mastodon feed for a user URL. Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67')` ).

			`Querystring options:`

			`\| option \| required \| description \|`
			`\| ------ \| -------- \| ----------- \|`
			\| `userurl` \| yes \| Mastodon/ActivityPub account URL (usually `https://${instance}/users/${username}`) \|
			\| `feedurl` \| no \| a URL to a page of an ActivityPub post collection. Only used for pages beyond the first. \|
Update README.md 2019-11-05 16:04:43 +01:00			\| `theme` \| no \| either `dark`, `light` or `auto`, to select the UI theme (default is `dark`). `auto` will appear light unless the user sets up dark mode on their device. \|
document v2 API 2019-08-02 19:33:03 +02:00			\| `boosts` \| no \| whether to show boosts or not \|
			\| `replies` \| no \| whether to show replies or not \|
			\| `size` \| no \| the scale of the UI in percent. \|

			`### V1 (deprecated, will now just redirect you to the v2 API)`

			#### GET `/api/feed`
Create README.md 2017-04-30 20:03:49 +02:00
Update README.md 2017-04-30 22:07:01 +02:00			> example: `/api/feed?url=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67.atom&scale=90&theme=light`
Create README.md 2017-04-30 20:03:49 +02:00
			Returns a html page which displays a mastodon feed for an atom feed URL. Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67.atom')` ).

Update README.md 2017-04-30 22:07:01 +02:00			`Querystring options:`
Create README.md 2017-04-30 20:03:49 +02:00

Update README.md 2017-04-30 22:07:01 +02:00			`\| option \| required \| description \|`
			`\| ------ \| -------- \| ----------- \|`
			\| `url` \| yes \| Mastodon Atom feed URL \|
Update README.md 2019-11-05 16:04:43 +01:00			\| `theme` \| no \| either dark, light or auto, to select the UI theme (default is dark). `auto` will appear light unless the user sets up dark mode on their device. \|
Update README.md 2017-04-30 22:07:01 +02:00			\| `size` \| no \| the scale of the UI in percent. \|

			`## Server Installation`
Create README.md 2017-04-30 20:03:49 +02:00
			This is a straightforward node project with zero databases or anything, you should just be able to run `npm install` and then `npm start` to get up and running. Set your `PORT` environment variable to change the port it listens on.

			`## Improve me`

			`Feel free to add a chaching layer, improve the styles and add more features.`