Apply sentence case to all H1s in docs/en/ and remove redundant "FreshRSS"
from titles where the docs site context already implies it. Align the three
section index titles to "Administrator/Developer/User manual", matching
the existing root H1 "FreshRSS manual (English)".
Add missing H1s to two pages that were silently dropped from the sidebar:
the user FAQ and the Caddy reverse proxy page. The sidebar template uses
page.title (derived from H1 by jekyll-titles-from-headings), so pages
without an H1 had title=nil and were skipped.
Update sidebar parent labels in docs_nav.html and the chapter list in
en/index.md to use the new "* manual" naming. Update link text in section
indexes that referenced the old H1s. Bundle two grammar fixes encountered
along the way: "an User Interface" -> "a user interface", and drop the
awkward "the" in "Configuring the email address validation".
EN only. No filenames, URLs, or anchor targets changed (anchors come from
H2 and below, which are untouched). FR is generated from EN via po4a and
will be regenerated separately.
Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
* docs: mention db-backup.php and simplify git update steps
Two follow-ups from Alkarex's review of #8741.
Backup: add ./cli/db-backup.php to the "What to back up" list as a
database-agnostic alternative to mysqldump/pg_dump. It was already
documented further down the page; the top bullet just didn't point
to it.
Updating: replace the 6-step prose list in "Using git" with a command
block matching the sequence in 07_LinuxUpdate.md. Drop the top-level
"move your backup outside the directory" warning; git reset --hard
doesn't need it, the real hazard is git clean -f -d removing
untracked files, so the warning sits inline on that line. Link to
the Linux page for the sudo and permissions-helper variant.
* docs: restore backup warning, clarify git clean note
Per @Alkarex review on #8763. Reword the inline `git clean` note to
cover untracked files generally (themes, extensions, local edits) since
backups are now called out separately above.
---------
Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
Closes the gap raised in #4553 by listing which folders matter for
backup (./data/, ./extensions/, ./i/themes/) and explicitly covering
the external-database case (MySQL, MariaDB, PostgreSQL).
While in the area, polish the surrounding update and backup pages:
- 04_Updating.md: restructure into one method per section (web
interface, git, zip archive, Docker), add a version-by-version
callout, modernize the version example, replace the brittle
footnote cross-reference with an inline rule, clarify the git
procedure (warning callout, tag-based version pinning), expand
the previously thin zip-archive section
- 05_Backup.md: add a "What to back up" overview, normalize heading
case, fix grammar throughout, simplify the restore flow from four
commands to one, rename the misleading "Saving Articles" section
to "Exporting your data", dedupe redundant SQLite-extension notes,
promote bold pseudo-headings to real subheadings
- 07_LinuxUpdate.md: update one link text to match the renamed page
Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
* docs: Fix broken or dead links
Used the following commands to find broken links:
1. `lychee -E --dump https://freshrss.github.io/FreshRSS/en/ --include freshrss.github.io --output links.txt`
2. `lychee -v --suggest --archive wayback --timeout 5 -u "Mozilla/5.0 (X11; Linux x86_64; rv:148.0) Gecko/20100101 Firefox/148.0" --files-from links.txt --output output.txt`
3. `cat output.txt`
Then did the same for https://freshrss.github.io/FreshRSS/fr/
We could look into using lychee in CI:
https://github.com/lycheeverse/lychee?tab=readme-ov-file#github-action-usage
* Replace PostgreSQL 16 link with current version
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Remove paragraph about bug message format
* Update README with official app website links
* Replace broken French images with English versions
* Fix broken Fever API docs link in French docs
* Replace GNU Social link with new one in `shares.php`
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Add a reference to the check where the warning is triggered
Note:
This is the place where the admin sees the browser pointing to.
Adding this information here allows the admin to find the matching
documentation entry.
* Update Content-Security-Policy section of english ServerConfig documentation
Note:
This fixes some minor formating/typping issues and adds some clarity to
the fact that this warning is also triggered on correctly configured
hosts, simply due to the nature of how correctness of CSP rules are checked.
* Move CSP infor source-code comment into console.info
Note:
Improve visibility of why this is happening.
* Point towards static website documentation instead of git
This URL should also remain more fixed even accross new branches/releases.
Co-authored-by: Inverle <inverle@proton.me>
* Minor fixes
* Remove overwrite part
---------
Co-authored-by: Inverle <inverle@proton.me>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
closes https://github.com/FreshRSS/FreshRSS/issues/8405
- Add documentation on how to trust own CA that issued self-signed certificate as authentik signing key
- Add example in Docker Example
How to test the feature manually:
1. Create your own CA
2. Issue a certificate
3. Use the issued certificate as a signing-key in authentik when configuring FreshRSS provider
4. Add created CA on host's CA store by running `update-ca-certificates`
5. Mount the `/etc/ssl/certs/ca-certificates.crt` file on FreshRSS container
6. Start the container
7. Navigate to FreshRSS in the browser
8. Authentik login form should be displayed and work as normal.
* Show warning when unsafe CSP policy is in use
* Fix bare markdown URL
* i18n: fr
* Minor i18n: fr
* Add target="_blank" to i18n strings
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Add API endpoint for extensions
Useful for https://github.com/FreshRSS/FreshRSS/issues/7572
* Support PATH_INFO
Now also support being invoked like `/api/misc.php/Extension%20Name/`
* More documentation
* Add documentation for OIDC login via Pocket IT
* Images for the Pocket ID OIDC docs
* Update 16_OpenID-Connect.md
* Recompress images (too big)
* Fix typo and reduce long lines
* Remove advise on changing username
Which only work to some extent with SQLite (breaking a few minor things such as WebSub, API) and not at all with other databases
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Regex search
fix https://github.com/FreshRSS/FreshRSS/issues/3549
* Fix PHPStan
* Fix escape
* Fix ungreedy
* Initial support for regex search in PostgreSQL and MySQL
* Improvements, support MySQL
* Fix multiline
* Add support for SQLite
* A few tests
* Added author: and inurl: support, documentation
* author example
* Remove \b for now
* Disable regex sanitization for now
* Fix getInurlRegex
* getNotInurlRegex
* Quotes for inurl:
* Fix test
* Fix quoted tags + regex for tags
https://github.com/FreshRSS/FreshRSS/issues/6761
* Fix wrong regex detection
* Add MariaDB
* Fix logic
* Increase requirements for MySQL and MariaDB
Check support for multiline mode in MySQL
* Remove sanitizeRegexes()
* Allow searching HTML code
Allow searching for instance `/<pre>/`
Fix https://github.com/FreshRSS/FreshRSS/issues/6775#issuecomment-2331769883
* Doc regex search HTML
* Fix Doctype
* Fix OIDC session params definition
- standardize environment variable names
- group all in the same configuration file
- use mod_auth_openidc default values
- fix `OIDCSessionMaxDuration` because it was not set with the previous
code
- add documentation
* Add double quoting to prevent globbing and word splitting
* Revert line deleted by mistake
* CLI database backup and restore
Can also be used to migrate from one database to another (e.g. MySQL to PostgreSQL) or to ease upgrade to a major PostgreSQL version (e.g. 15 to 16).
* +x
* Fix some cases
* Update to docker-compose-v2
* More documentation
* Update 16_OpenID-Connect-Authentik.md
updated docs
* Add files via upload
* Update 16_OpenID-Connect-Authentik.md
Updated documentation with many clarifications. The most important one is the redirect URL which must include the port or it will not work. To ensure compatibility, I have recommended both URLs be added, with and without the port. Example docker-compose also added with traefik reverse proxy.
* Reduce screenshot size
* Fixes and improvements
* Allow changing auth to HTTP
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Fix ignored TRUSTED_PROXY issue
* Add a sub-section to the docs no property mappings for Authentik
* Typo
* Fix typing
* A few changes to the doc
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
