dertuxmalwieder / rssfs

The RSS file system (Git mirror)

rssfs: A RSS reader as a file system

Are you unsure how to read RSS feeds? Why don't you just mount them?

What does this software do?

It will mirror RSS and Atom feeds as file systems. Example file system structure for one feed with two articles:

/tmp/mnt/rssfs/Open Source Feed/Hello World.html
/tmp/mnt/rssfs/Open Source Feed/Second Article.html

Compatibility

This software is written and tested mainly on macOS with macFUSE. Other FUSE implementations should work as well.

A note on Windows support

As Windows would require WinFsp which might or might not properly support FUSE file systems, Windows is officially unsupported as of now (which means: the time that you read this). Tests and contributions are welcome!

Build

fossil clone https://code.rosaelefanten.org/rssfs
cd rssfs
go build

Configure

Copy rssfs.hcl-example as rssfs.hcl to your configuration directory and adjust your settings. The required path is:

• On Windows: %APPDATA%\rssfs.hcl
• On macOS: $HOME/Library/Application Support/rssfs.hcl
• Elsewhere: $XDG_CONFIG_HOME/rssfs.hcl (or $HOME/.config/rssfs.hcl)

Set a mountpoint (unless you are on Windows) and one or more feeds which can be inside or outside a category. (Categories are not required. Subcategories are not supported.)

If you don't define cache, the feed will be fetched every time you open any other feed.

Default values for feed settings

• plaintext: false
• showlink: false
• cache: false
• cachemins: 60

Run

macOS and other non-Windows machines

./rssfs

Windows

Not implemented yet. Sorry.

Repositories

• AUR: aur.archlinux.org

rssfs's Issues

Publish in Linux repos

Please, publish binaries in different distro repos.

nil pointer deference on tree call

1. cd onto root rssfs dir
2. tree
3. crash

⏱️  rssfs starting up.
🔧  Using configuration file: /home/nikto_b/.config/rssfs.hcl
⚙️  Trying to mount rssfs into /tmp/mnt/rssfs...
🚀  Ready! Unmount to terminate.
🔄  Updating feed contents.
🔄  Updating feed contents.
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0xf8 pc=0x8a8693]

goroutine 37 [running]:
main.UpdateSingleFeed(0xc0002b6380, 0x3e9, 0x0, 0xfd89f0, 0x4900c5, 0xc0000b2060, 0xc00044a000)
	/home/nikto_b/.cache/yay/rssfs/src/rssfs/feed-helpers.go:37 +0x133
main.PopulateFeedTree(0xc0000ad7e0, 0xe, 0xc0000b0760, 0x1, 0x1, 0xc0000b0780, 0x1, 0x1, 0x2)
	/home/nikto_b/.cache/yay/rssfs/src/rssfs/feed-helpers.go:94 +0x1ca
main.(*RssfsNode).Readdir(0xc0002ba320, 0xbac140, 0xc0004384e0, 0x7f8bd973b068, 0xc0002ba320, 0x40dc01)
	/home/nikto_b/.cache/yay/rssfs/src/rssfs/driver-fuse.go:112 +0x2ac
github.com/hanwen/go-fuse/v2/fs.(*rawBridge).getStream(0xc000690c60, 0xbac140, 0xc0004384e0, 0xc0002ba320, 0x203000, 0xc000690d38, 0x9d36c8)
	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fs/bridge.go:866 +0x294
github.com/hanwen/go-fuse/v2/fs.(*rawBridge).setStream(0xc000690c60, 0xc0005ae1e0, 0xc000692198, 0xc0002ba320, 0xc0000e0000, 0x30)
	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fs/bridge.go:852 +0xb6
github.com/hanwen/go-fuse/v2/fs.(*rawBridge).ReadDirPlus(0xc000690c60, 0xc0005ae1e0, 0xc000692198, 0xc000258c90, 0x0)
	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fs/bridge.go:914 +0xfb
github.com/hanwen/go-fuse/v2/fuse.doReadDirPlus(0xc00017c2c0, 0xc000692000)
	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fuse/opcode.go:174 +0xf6
github.com/hanwen/go-fuse/v2/fuse.(*Server).handleRequest(0xc00017c2c0, 0xc000692000, 0xc000000000)	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fuse/server.go:472 +0x2bf
github.com/hanwen/go-fuse/v2/fuse.(*Server).loop(0xc00017c2c0, 0xc000480001)
	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fuse/server.go:445 +0x18a
created by github.com/hanwen/go-fuse/v2/fuse.(*Server).readRequest
	/home/nikto_b/go/pkg/mod/github.com/hanwen/go-fuse/[email protected]/fuse/server.go:312 +0x417

Config:

mountpoint = "/tmp/mnt/rssfs"

category "Work" {
    feed {
        url = "https://www.upwork.com/ab/feed/jobs/atom?ontology_skill_uid=996364628025274376%2C996364628025274382&paging=0%3B20&q=NOT+%28iOS+OR+React+OR+Js%29&sort=recency&api_params=1&securityToken=416b245e662b026a6b9cf1062e3171ba11e4a67866bdb6466e3ac6217fa41ca21af6c6101e7afb734991d197695bac521076fa851933e69c398b891377315967&userUid=1270432881283956736&orgUid=1270432881288151041"
    	showlink = true
        plaintext = false
    }
}

feed {
    url = "https://www.upwork.com/ab/feed/jobs/atom?ontology_skill_uid=996364628025274376%2C996364628025274382&paging=0%3B20&q=NOT+%28iOS+OR+React+OR+Js%29&sort=recency&api_params=1&securityToken=416b245e662b026a6b9cf1062e3171ba11e4a67866bdb6466e3ac6217fa41ca21af6c6101e7afb734991d197695bac521076fa851933e69c398b891377315967&userUid=1270432881283956736&orgUid=1270432881288151041"
}

Title as filename

Some rss feed entries might have same title, but files are identified by their full path. So there is an issue with representation of such rss entries.

Probably it is possible to add number to title in some fashion like this:

1) Title
2) Title

But not sure with that