search

fossar / selfoss

multipurpose rss reader, live stream, mashup, aggregation web application
https://selfoss.aditu.de
GNU General Public License v3.0
2.36k stars 343 forks source link

Make usage instructions clearer + demo #1293

Closed sheeepdev closed 1 year ago

sheeepdev commented 2 years ago

Hello! I just saw selfoss while searching for a self-hosted RSS reader. From the screenshots I love the user interface, but unlike other RSS readers like FreshRSS selfoss does not have a demo. It also doesn't have clear usage/installation instructions. From what I read I have no idea how to start it up. I see that there was some effort put in to try and make a docker image and it seems someone did succeed in making it. But to a normal user trying to use this it is very confusing

jtojnar commented 2 years ago

We have a demo here https://selfoss-test.herokuapp.com/ (username and password are demo), I have just updated it to latest build. Still need to set up CI to update it periodically. I have not linked it much because I worry about abuse (e.g. people adding spam feeds). Maybe I should make it read only. Or add a one-click button so that people can deploy it somewhere.

The installation instructions are on the website but I can see some parts where they could be clearer (e.g. it mentions uploading files but not where one should upload them). I also tried to add some more options on the upcoming website page but the Docker support is still unofficial. But the installation should really be as simple as extracting selfoss.zip into the web server directory.

sheeepdev commented 2 years ago

We have a demo here selfoss-test.herokuapp.com (username and password are demo), I have just updated it to latest build. Still need to set up CI to update it periodically. I have not linked it much because I worry about abuse (e.g. people adding spam feeds). Maybe I should make it read only. Or add a one-click button so that people can deploy it somewhere.

The installation instructions are on the website but I can see some parts where they could be clearer (e.g. it mentions uploading files but not where one should upload them). I also tried to add some more options on the upcoming website page but the Docker support is still unofficial. But the installation should really be as simple as extracting selfoss.zip into the web server directory.

Nice, thanks for the clarification, I would suggest you to add the demo link to the README and the website.

jtojnar commented 2 years ago

Heroku unfortunately removes the free tier so we will need to find out something else.

sheeepdev commented 2 years ago

I suggest using maybe netlify instead?

jtojnar commented 2 years ago

That would work for the front-end but it does not look like Netlify supports PHP https://answers.netlify.com/t/how-to-host-php-websites/7410

jtojnar commented 1 year ago

I have updated the installation instructions: https://selfoss.aditu.de/docs/administration/installation/basic/ The website is now using Netlify. Still no demo, though.