Commit Graph

14 Commits

Author SHA1 Message Date
polybjorn
726dc1d17f docs: clarify backup guidance and overhaul update guide (#8741)
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>
2026-05-01 08:11:40 +02:00
Alexandre Alapetite
d56d791baf Update composer shfmt typos (#6614) 2024-07-08 12:00:58 +02:00
Alexandre Alapetite
4f957dfc4c Doc git latest (#5148)
#fix https://github.com/FreshRSS/FreshRSS/issues/4949
2023-02-28 08:11:27 +01:00
Alexandre Alapetite
e899e4edd9 More robust application of access permissions (#5062)
* More robust application of access permissions
We were in particular missing directory traversal `+X` in our current recommendations.
Extracted to own shell script so it can easily be invoked.
Update access permissions in Docker to account to be more robust.
#fix https://github.com/FreshRSS/FreshRSS/discussions/5037

* Minor simplification

* Restrict mkdir permissions
Default mkdir permissions are 0777, which is not good for security, so downgrade to 0770.
2023-02-06 15:42:53 +01:00
berumuron
a38fe3a15e doc: Add recommendations for manual updates (#4557) 2022-08-29 21:11:54 +02:00
Alexandre Alapetite
1acd3ab09b Use typographic quotes (#4133)
* Use typographic quotes

* A few fixes

* Fix

* Fix not saved

* Implement feedback

* Detail

* Revert spoken English fixes
Left for a future dedicated discussion

* More reverts

* Final reverts

* Final minor
2022-01-08 21:58:55 +01:00
Alexandre Alapetite
acbba9adb2 Improved markdownlint (#3918)
* Improved markdownlint
* Relaxed rules slighlty
* `npm run markdownlint` for automatic tests
* `npm run markdownlint_fix` for automatic syntax fixing
* Applied the fixes on all our Markdown files
2021-10-23 13:43:24 +02:00
berumuron
cc6c529562 tec: Remove data/do-install.txt (#3555)
* Remove file data/do-install.txt

This file was painful during update because we had to remember to delete
it each time. It added a security issue by allowing an attacker to
reinstall FreshRSS during the update process.

The (more powerful) file data/applied_migrations.txt has been introduced
in 8619cf6fa to replace do-install.txt. We had to wait for at least one
release in order to make sure existing instances of FreshRSS created the
migration file. It should be ok now.

* Replace i18n install.not_deleted key

* Update documentation to update FreshRSS
2021-03-26 19:41:33 +01:00
Alexandre Alapetite
1c3159058f Quick update the doc for master renaming to edge 2021-03-15 00:00:25 +01:00
Troy Engel
1401186a48 pause automatic updates during upgrade (#2893) 2020-04-11 17:47:08 +02:00
Ths2-9Y-LqJt6
06c918d0d9 Fix wget in linux update guide (#2858)
* change link from wget to curl in linux update guid #2857

* change back to wget per feedback  #2857
2020-03-29 22:05:16 +02:00
Marien Fressinaud
82851d2039 Make master the rolling release branch (#2705)
* Change default TAG in Makefile

We are going to drop the `dev` branch. The Docker tag `dev-*` are based
on this branch and so there will be no longer be generated. We must use
images based on the `master` branch (i.e. `latest`, `alpine` and `arm`).

* Remove references to dev branch in documentation

* Synchronize French documentation
2019-12-15 14:08:49 +01:00
MonsieurP0uet
67fc72fb61 Correction in the line 38 (#2628) 2019-11-02 23:49:02 +01:00
Patrick
d7f8883926 Docs update (#2164)
* Update Readme.conf

Add information in Readme.conf to hopefully stop bug reports about intended behavior.

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* Update README.md

Co-Authored-By: pattems <patrick@crandol.com>

* Update Readme

* Update Documentation Section

* Add main Documentation link near top of Document

* Make Documentation header a link

* Fix spelling mistake I didn't catch

* Apply suggestions from code review

Co-Authored-By: pattems <patrick@crandol.com>

* Changes per Frenzie comments

* Move non-disclaiming disclaimer

* English Admin Documentation Update

* Add Backup section

* Update wording in Index

* Move Footnotes to End

* Move Footnote

* Add content for todos

* Fix typos

* Fix a bunch of typos

* Remove a duplicated file (forgotten during dev merge)

* Improve the documentation a bit
2019-10-22 11:17:12 +02:00