The Shout webreader is a self-hostable web application that you can use to browse feeds generated by your profiles!
Installation
Clone this repository. git clone https://www.git.jnichols.info/shout-webreader
Enter the directory. cd shout-webreader
Create a run script. cp example.sh run.sh
Run the webreader. ./run.sh
File Structure
You can safely ignore most of the files here, but there are a couple of locations that you are encouraged to add your own stuff to:
assets: Used for local files, particularly HTML files you want to replace the header/body of your homepage with.
profiles: Put your Shout profiles here. Any profiles will be selectable on the homepage.
public: Public files, like CSS or images. Useful with the SHOUT_HEADER option!
Configuration
In your run script, there are a few options that you want to know about.
LISTEN_HOST: Where the webreader listens.
EXTERNAL_HOST: Where your webreader can be located on the internet.
SHOUT_HEADER: A reference to a local file that replaces the main page header.
SHOUT_BODY: A reference to a local file that replaces the main page body.
SHOUT_PROFILES: A root directory for your profiles. This is set to profiles in the example script, which is the default. Put profiles here to use them in the webreader!
SHOUT_PROFILE: The default profile to use.
SHOUT_ALLOW_REMOTE: If true, opens an extra option for people to load profiles from remote sources.
Notes
To bring your own CSS, add it to the public directory, then copy header.html in assets and modify the copy to use your CSS.
Roadmap
Proper API that allows access to full aggregated output of profiles