mbrock / telegroam Goto Github PK

View Code? Open in Web Editor NEW

91.0 6.0 43.0 27 KB

License: MIT License

JavaScript 99.92% Procfile 0.08%

telegroam's Introduction

Telegroam: a bridge between Roam and Telegram

Send messages and photos to your own Telegram bot and have them appear in the Daily Notes page of your Roam graph.

You don't need to run any software or servers other than this JavaScript plugin for your Roam graph.

⚠️ Warning!

If you use the default proxy URL as in the instructions below, your media files will get passed through a trusted middleman.

You can run your own proxy easily using Heroku's free tier. This is how I run my proxy.

Click the button below and Heroku will guide you through the whole thing with zero configuration or coding. You will end up with your very own proxy URL.

Why is a proxy necessary?

A proxy is necessary because of how Telegram's API works.

When Telegroam receives a photo, video, or audio, it has to download that file from Telegram in order to upload it to Roam's file storage.

But Telegram doesn't allow the browser to download its files, probably because of a bug. Instead we have to download via the proxy server.

Installation

I will make this more convenient later.

In Telegram, talk to @BotFather to create a new bot and get an API key for it.
Send something to your bot in a private message.
Make a page in your Roam called [[Telegram Bot]].
Paste these nodes somewhere on the [[Telegram Bot]] page:
- Inbox Name:: [[Inbox]]
- API Key:: insert key you get from Telegram's bot system
  - {{[[TODO]]}} update the Telegram API key above
- Trusted Media Proxy:: https://telegram-cors-proxy.herokuapp.com
- Latest Update ID::
Make a block with the text {{[[roam/js]]}}.
Nested in that block, make a code block and paste the full contents of telegroam.js inside.
Reload Roam.

telegroam's People

Contributors

Stargazers

Watchers

telegroam's Issues

not working?

I just tried installing a telegroam bot. Followed the instruction but it didn't work. - What might have gone wrong?

Can I use two bots in one roam graph?

about the feature of telegroam.

Inbox tag on every Daily Note page

The Inbox tag appears at the top of every Daily Note, even when I didn't send anything through the Telegram bot. Any way to fix it?

Migrate to Official Roam Plugin Store?

Are there plans to submit this to the brand new official Roam Depot plugin store? Would be a real shame for this great plugin to get left by the wayside when the store opens!
https://twitter.com/hashbrown490/status/1545198251493584896

There's also some fancy API hooks for embedding extension settings into Roam

Feature request: queries

So we can read our db instead of only writing to it :)

Multi-block notes?

I would like to be able to send myself notes that include nested sub-blocks. Like this:

top line
- second line
- third line

Right now, it seems like each message is a single block and they can't be nested. Any chance this could change?

Still cannot get this to work

I followed everything as instructed but I can't see my messages in Roam. Appreciate any help in troubleshooting

Media URLs from Telegram are not stable

The URLs we get from Telegram’s getLink method are not persistent. I don’t know how long they actually last.

Supposedly the files themselves and the file IDs are persistent. But it seems that we would need to download the files and upload them somewhere else.

Can we upload to Roam’s Firebase storage? I don’t know.

Heroku is ending their Free Plan Tier

Seems as though heroku will be shutting down all free-tier projects in the coming months which means that telegroam will also stop working I believe

https://blog.heroku.com/next-chapter

cors-anywhere has a good discussion about alternatives but this project should probably start to migrate as well since the official telegroam proxy server is hosted on heroku

Error: attribute Latest Update ID missing from [[Telegram Bot]]

I message my new telegram bot but nothing appears in roam

Only create inbox parent block if a message is received

Right now the inbox block in created on every single daily notes pages regardless of whether or not you sent a message. This clogs up the graph a bit with empty and useless mentions. Would it be possible to only create that inbox parent block if a message has been sent to telegroam?

The inbox should be created at the bottom of the Daily Notes

https://twitter.com/iHeartNovi/status/1460414474003914755

Heroku says: Source code violates the Salesforce Acceptable Use

When I try to deploy app, I see message: Item could not be created: We couldn't deploy your app because the source code violates the Salesforce Acceptable Use and External-Facing Services Policy

Default Inbox

Feature request: Right now notes get sent to the top level of the current Daily Notes Page (DNP). I would prefer them to be grouped under a header "Inbox" - either creating that section if it doesn't exist, or if it does then adding them at the bottom of that section.

Telegroam: TypeError: Failed to fetch

The script works well mostly, but sometimes there is a popup showing this message.
Don't know how to mute it, since disable the notification doesn't work.

Did this stop working?

I was using it fine till yesterday. And now the messages have stopped appearing in Roam. Any ideas?

Error: Trusted Media Proxy missing

Any idea what I'm doing wrong? I'm getting the following error after I run the Javascript code-block:

Block format

This is amazing. It is wonderfully fast and great with files.

It is possible to change the formatting of the blocks. I don't need user name or time signature.

Also, is it possible to send emails to the Telegram bot? This would open new possibilities.

Many thanks.

I thought the "Deploy" button would start with some kind of template, but that doesn't seem to be the case.

Thanks for this!