Skip to content

nicolecomputer/tumblr-rss-monster

Repository files navigation

Tumblr RSS Monster

Hey! So, you want to read your tumblr feeds in your RSS reader, huh? You want to be able to grab your dashboard or share your liked posts with someone else or maybe follow a couple of blogs? Well this is the project for you.

Tumblr RSS monster is a bridge that connects to Tumblr via their API and generates you RSS feed goodness. Because it uses the API and is authenticated you'll be able to get feeds for private or NSFW blogs that normally require you to be logged in.

What does it look like?

Screen of admin page

The hope is that you're not spending too much on admin screens so these pages have been designed to get you in, get you logged into tumblr, and then get the feed urls. The hope is that you won't need to pop in too often.

Deploying

This project is deployed as a docker container.

> docker pull ghcr.io/nicolecomputer/tumblr-rss-monster:main

A Note on security

Please don't expose this to the public internet. You want this to run on a local box that only your rss reader can access. There isn't any protection against anyone and everyone using your instance for their account and tumblr has api limits that mean you won't be able to enjoy your feeds.

Environemnt variables:

Mounts:

You'll want to mount a folder that will persist between deploys.

  • /data: location for database, cache, and cookie storage

Ports

This project exepcts the container's port of 6969 to be forwarded to your destination port.

Usage

After installing and starting navigate to http://127.0.0.1:6969 You'll be able to login as a tumblr user and see the rss feeds that have been generated.

Development

Tumblr-Dashboard-RSS is written in Typescript. To get started you need to:

  • Clone the project
  • Install the dependencies (yarn install)
  • Create a .env file in the project root with the name environment variables docker expects
  • Set TUMBLR_CONSUMER_KEY, TUMBLR_CONSUMER_SECRET in the .env file
  • Start the project (yarn start)

This will start a process that will watch the source code (located in src/) for changes, compile those changes from typescript to javascript, output the javascript to dist/ and run the program.

There's a .devcontainer setup in this project to make things easier to setup. You can get started quickly with either VSCode's remote container support or Github's codespace.

Credits

Tumblr RSS Monster started life as tumblr-dashboard-rss by Meyer and then morphed into this monster by NicoleComputer.

Be nice.