Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/homeworkprod/einwurf

Minimal unauthenticated web UI to accept and forward notes (to Discord, Mattermost, or Notion)
https://github.com/homeworkprod/einwurf

discord mattermost notion notion-api webhook webhooks

Last synced: about 2 months ago
JSON representation

Minimal unauthenticated web UI to accept and forward notes (to Discord, Mattermost, or Notion)

Host: GitHub
URL: https://github.com/homeworkprod/einwurf
Owner: homeworkprod
License: mit
Created: 2023-01-29T13:53:41.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-05-18T11:37:03.000Z (7 months ago)
Last Synced: 2024-10-12T06:28:08.961Z (3 months ago)
Topics: discord, mattermost, notion, notion-api, webhook, webhooks
Language: Rust
Homepage: https://homework.nwsnet.de/releases/e1ff/#einwurf
Size: 46.9 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Einwurf

Accept notes, URLs, etc. with a public, minimal web UI (just a text area
and a submit button) without authentication and post them to another,
likely access-restricted destination of choice.

Use case: You are browsing the web on your phone or work computer and
come across an idea or link you want to engage with later (say, at home
on your private computer).

With **Einwurf**, you can just open the web interface, "drop" those
notes, and know they got appended to some list you can access later.

Currently these destinations are supported:

* [Discord](https://discord.com/): Write to a channel.
* [Mattermost](https://mattermost.com/): Write to a channel.
* [Notion](https://www.notion.so/): Append to a page.

## Usage

An example configuration file with explanations on how to obtain or
choose values is included as ``config_example.toml``.

A configuration file is mandatory to run it:

```sh
$ einwurf --config config.toml
```

It is recommended to run Einwurf on `localhost`/`127.0.0.1` only and
expose it through a reverse proxy that also provides
[TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security).

For example, [nginx](https://nginx.org/) could be set up like this (with
[Certbot](https://certbot.eff.org/) used to manage certificates):

```nginx
server {
listen 443 ssl;
server_name einwurf.example;

location / {
proxy_pass http://127.0.0.1:3000/;
proxy_redirect off;
}

ssl_certificate /etc/letsencrypt/live/einwurf.example/fullchain.pem; # managed by Certbot
ssl_certificate_key /etc/letsencrypt/live/einwurf.example/privkey.pem; # managed by Certbot
}
```

## License

Einwurf is licensed under the MIT license.