Skip to content

scripting/feedlandInstall

Repository files navigation

FeedLand server install

Instructions for setting up a FeedLand server.

About FeedLand

I've been running a FeedLand server myself since October 2022.

It was always the plan to let other people run their own FeedLand instances, but first I wanted to be sure the server ran reasonably smoothly, and the UI was stable.

I think at the beginning of 2023 we've gotten there.

Hence this package.

How to install

When you follow the setup instructions you will have a FeedLand instance running on your server.

You can use it yourself, or share it with others. Or use both models at the same time.

If you're just using it yourself it does not have to be accessible over the net.

Where's the source code?

The server software is layered as a stack of Node packages that build on each other. These are the packages Dave Winer wrote and maintains. The top level stuff is GPL2-licensed, the lower level packages are MIT-licensed.

  • feedland -- the top level, the HTTP and websockets interface that connects to the browser-based client.

  • feedlanddatabase -- the code that manages the tables for users, feeds, items, subscriptions, likes.

  • opml -- reading and writing OPML files for subscription lists.

  • reallysimple -- reading RSS, Atom, RDF feeds.

  • daverss -- publishing RSS feeds.

  • daveappserver -- handles the file system, mid-level web server, email, identity.

  • davetwitter -- interfacing with the Twitter API, identity.

  • davegithub -- writing to GitHub repos, for backups.

  • davehttp -- low-level HTTP functionality.

  • davesql -- interfaces to MySQL, queuing.

  • davemail -- sending email.

  • daves3 -- reading and writing to and from Amazon S3.

HTTPS

If you're using HTTPS, Scott Hanson has written a guide to setting up FeedLand with HTTPS.

There's a special example config.json derived from a working HTTPS installation.

No pull requests, please

I can't accept pull requests because I edit the code in an outliner, that's what source.opml is all about.

So the best thing to do when you spot a mistake is flag it as an issue in the repo, point to the code in question if that's helpful, and I'll thank you and make the fix myself.

And if you want to add a feature and have it included in this distribution, post an issue and let's talk about it. ;-)

Questions, support

If your questions are about server installation and setup, post a note in issues section of this repo.

If you need help with using FeedLand to manage and share feeds, post a note in the FeedLandSupport issues section.

No matter where you post it, please look to see if your question has been covered in other threads, and please be respectful.

About

Instructions for setting up a FeedLand server.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published