Commit 30e02e0f authored by yPhil's avatar yPhil
Browse files

Yet another menial commit to fix typos in the friggin' docs

parent 30a70204
Pipeline #409042 passed with stage
in 36 seconds
......@@ -13,6 +13,10 @@
- Single quotes in JS, double quotes in HTML ;
- Indents: 2 *spaces*.
## VC workflow
All work is done on `dev` or its child branches, then merged into `server` and pushed for testing, then merged into master at each release or critical bugfix. Pull Requests on `dev`, please.
## Installation notes & caveats
The two libs [Feedrat](https://framagit.org/yphil/feedrat) (to discover a RSS/Atom feed at a given URL) and [Favrat](https://framagit.org/yphil/favrat) (to discover a favicon at a given URL) are no longer hosted on npm, but installed directly from the repo ; however their dependancies have to be installed manually by running `npm install` in their respective directories.
......@@ -32,13 +36,18 @@ Pétrolette is its own server, a standard [express](https://github.com/expressjs
At the first startup, Pétrolette generates its page using a default tabs and feeds list, then copies this structured list the the client's local storage persistent cache. The user can (should) also use a third party cloud storage to write / read his / her tabs and feeds, in order to have the same contents on all machines : Desktop, laptop, phone, etc.
Why is there a server in the first place, **why can't the client do all the RSS requests?** Because of [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), that's actually the *only* reason, if you exclude my desire to learn server-side JS :)
## Why is there a server in the first place ?
**why can't the client do all the RSS requests?** Because of [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), tjat's why and it's actually the *only* reason, if you exclude my desire to learn server-side JS :)
pm2 automatically restarts both Pétrolette when its files are edited (excluding cache and module/lib directories, of course, see [pm2.config.json](pm2.config.json)) and itself if the host machine restarts.
### Server configuration
The ports are set up in [the config file](./package.json). To redirect on a vanilla Linux box :
`iptables -t nat -I PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 8000`
`iptables -t nat -I PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 8001`
### Logging
......
......@@ -11,7 +11,7 @@
## Good morning! ☕ 📰
[Pétrolette](http://petrolette.space) is a news reading home page, [free](https://framagit.org/yphil/petrolette/-/blob/master/LICENSE). It is immediately usable **without registration** with the same URL on the desktop or a mobile device.
[Pétrolette](http://petrolette.space) is a news reading home page, [Free, Libre, and Open-Source Software](https://framagit.org/yphil/petrolette/-/blob/master/LICENSE). It is immediately usable **without registration** with the **same URL** on the desktop or a mobile device.
Go ahead, it's yours : Create, delete, move feeds and tabs, close / quit your browser, come back tomorrow, everything is how you left it.
......@@ -27,9 +27,10 @@ Pétrolette is fully self-contained, makes **no external call** whatsoever, and
- No ads, no trackers, just the news
- Displays all modern feeds (Atom, Media-RSS, etc.)
- **Video / Audio playing** directly in Pétrolette
- **Discovery of the feed** in a page / website
- Mobile / **phone** / tablet / responsive interface
- Search within all the feeds
- **Discovery of the feed** in a page / website
- Direct link to all the article / item's resources (image, video, sound)
- Advanced image management (download, gallery, slidewhow, etc.)
- Import / export of the tabs & feeds file (replace / merge)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment