aboutsummaryrefslogtreecommitdiff
path: root/Docker/README.md
AgeCommit message (Collapse)Author
2025-11-17Fix Docker for PostgreSQL (#8224)Gravatar Alexandre Alapetite
Better fix instead of https://github.com/FreshRSS/FreshRSS/pull/8216 Based on error message: Error: in 18+, these Docker images are configured to store database data in a format which is compatible with "pg_ctlcluster" (specifically, using major-version-specific directory names). This better reflects how PostgreSQL itself works, and how upgrades are to be performed. See also https://github.com/docker-library/postgres/pull/1259 Counter to that, there appears to be PostgreSQL data in: /var/lib/postgresql/data (unused mount/volume) This is usually the result of upgrading the Docker image without upgrading the underlying database using "pg_upgrade" (which requires both versions). The suggested container configuration for 18+ is to place a single mount at /var/lib/postgresql which will then place PostgreSQL data in a subdirectory, allowing usage of "pg_upgrade --link" without mount point boundary issues. See https://github.com/docker-library/postgres/issues/37 for a (long) discussion around this process, and suggestions for how to do so.
2025-09-11Docker healthcheck (#7945)Gravatar Alexandre Alapetite
* Docker healthcheck fix https://github.com/FreshRSS/FreshRSS/issues/7377 * Use echo for non-CLI error * curl_close is deprecated * Connection: close * Update cli/health.php Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> --------- Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2025-02-19Docker Compose remove deprecated version (#7309)Gravatar Alexandre Alapetite
Minor doc
2025-01-25Doc changed default_user to default-user (#7238)Gravatar Max Bretschneider
2024-12-27Adds BASE_URL to example .env file (#7151)Gravatar Christopher Moss
* Adds BASE_URL to example .env file I found without specifying a BASE_URL then the installation command gets confused ❌ FreshRSS error during installation! FreshRSS error: invalid input: default-user cannot be empty The provided example base url may not be desired, but the readme should be updated with 'something' to make first use more user friendly. * Update Docker/README.md --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-08-14Update about running tests (#6709)Gravatar Alexandre Alapetite
2024-04-30CLI database backup and restore (#6387)Gravatar Alexandre Alapetite
* 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
2024-03-19Fix CLI install regressions (#6214)Gravatar Alexandre Alapetite
* Fix CLI install with prefix It was not possible to pass a blank prefix * Fix regression EXIT_CODE_ALREADY_EXISTS The dedicated exit code was not sent anymore when a user already exists
2023-11-10Document Traefik PathPrefix (#5845)Gravatar Alexandre Alapetite
2023-11-08Update WebSub documentation a bit (#5829)Gravatar Alexandre Alapetite
* Update WebSub documentation a bit * Marien prefers not to promote his hub too much :-)
2023-11-05Fix FreshRSS logo link on Docker HubGravatar Alexandre Alapetite
The link resolution does not seem to be supported automatically Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5819
2023-11-05Try automatic update of Docker descriptionGravatar Alexandre Alapetite
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5819
2023-11-05add multi arch docker build (#5808)Gravatar Benjamin Reich
* Add multi arch container build Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * using label from github action * dont remove static labels and split docker readme in seperate action * pin 3rd party action to a commit * enable pushing to dockerhub * Update .github/workflows/build-images.yml Co-authored-by: EdJoPaTo <github@edjopato.de> * remove not needed checkout * set github token permissions * Update .github/workflows/push-dockerhub-readme.yml * update docker readme to match new tags * Apply suggestions from code review * fix suffix for alpine image * fix suffix for alpine image * push images only at upstream repo * push images only at upstream repo * push images only at upstream repo * tag latest-alpine as alpine * tag latest-alpine as alpine * remove no needed falvor * keep falvor for build * Clean more things * Rename action To use same default name than https://github.com/actions/starter-workflows/blob/main/ci/docker-publish.yml * Rename readme action To use same default name than https://github.com/peter-evans/dockerhub-description/blob/main/.github/workflows/dockerhub-description.yml * Use default name for dockerhub-description https://github.com/peter-evans/dockerhub-description/blob/main/.github/workflows/dockerhub-description.yml Plus minor wording * Experiment with build-args * Debug * Add checkout back * Revert back to metadata-action * Remove quotes in version * Try to fix variables * Experiment with automatic label values again * Delete last Docker Hub hooks * Use only git SHA for org.opencontainers.image.revision https://specs.opencontainers.org/image-spec/annotations/#pre-defined-annotation-keys * Comment out semver for now Might be enabled later if desired * Enable major semver --------- Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: EdJoPaTo <github@edjopato.de>
2023-10-25Use RemoteIPInternalProxy directive of remoteip Apache module (#5740)Gravatar Mossroy
* Use RemoteIPInternalProxy directive of remoteip Apache module instead of RemoteIPTrustedProxy directive To allow internal IPs to be trusted: for internal clients, and also for the case of chained internal reverse-proxies Fixes #5726 * One last reference forgotten --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-09-09Docker MySQL update doc (#5639)Gravatar Alexandre Alapetite
Remove obsolete parameter not needed anymore now that all our images are using PHP 8+
2023-07-30Rework trusted proxies (#5549)Gravatar Alexandre Alapetite
* Rework trusted proxies Fix https://github.com/FreshRSS/FreshRSS/issues/5502 Follow-up of https://github.com/FreshRSS/FreshRSS/pull/3226 New environment variable `TRUSTED_PROXY`: set to 0 to disable, or to a list of trusted IP ranges compatible with https://httpd.apache.org/docs/current/mod/mod_remoteip.html#remoteiptrustedproxy New internal environment variable `CONN_REMOTE_ADDR` to remember the true IP address of the connection (e.g. last proxy), even when using mod_remoteip. Current working setups should not observe any significant change. * Minor whitespace * Safer trusted sources during install Rework of https://github.com/FreshRSS/FreshRSS/pull/5358 https://github.com/FreshRSS/FreshRSS/issues/5357 * Minor readme
2023-06-12Add OpenID Connect (#5351)Gravatar Aaron Schif
* Add OIDC * Update documentation. * Update apache conf adding IfModule * Use IfDefine for OIDC in apache conf * Fix non-oidc support * Fix typing * Use IfDefine to enable OIDC * Add OIDC support to all dockerfiles * Re add apache Require option * Fixes and documentation * A few more fixes * A bit more doc * Change type of environment variable * Update readme * Correct apache config for OIDC support. * Fix README formatting * Update oidc control path * Fix oidc endpoint being cached * A bit more review * Simplify ExpiresActive * Add session refresh and improve caching * Allow more different setups * A bit more documentation * A bit more readme --------- Co-authored-by: Aaron Schif <aschif@netdevgroup.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: maTh <math-home@web.de>
2023-05-28Improve Dev Container (#5423)Gravatar Alexandre Alapetite
* Improve Dev Container PHPStan was failing in Dev Container * Update Docker to Alpine Linux 3.18 * New DATA_PATH environment variable * README
2023-05-07docs: language table added (#5375)Gravatar maTh
* docs: language table added * Update 05_Configuration.md * Update 05_Configuration.md * french docs * Unicode quote and a few fixes (Same search&replace aslo applied to a few other files) --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-03-30Document automated Docker build from git (#5237)Gravatar Alexandre Alapetite
* Document automated Docker build from git Fix https://github.com/FreshRSS/FreshRSS/issues/5236 Contributes to https://github.com/FreshRSS/FreshRSS/issues/4089 * Rolling
2023-03-26[Docker] Listening for IPv6 connections (#5180)Gravatar Rufubi
* Listen for IPv6 connections * Added information about LISTEN6 variable * Make LISTEN variable a comma-separated list of values * Removed debug commands * Revert changes --------- Co-authored-by: Rufubi <>
2023-03-13docs: fix nginx configuration (#5194)Gravatar witchcraze
Update nginx nginx configuration in `Hosted in a subdirectory type.`
2023-03-07Add docker-compose instructions for ARM64 (#5175)Gravatar Rebecca Scott
* Add docker-compose instructions for ARM64 * Update Docker/README.md * Update Docker/README.md --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-11-30Docker uniform timezone behaviour (#4905)Gravatar Alexandre Alapetite
* Docker Alpine timezone for :newest and :oldest Follow-up of https://github.com/FreshRSS/FreshRSS/pull/4903 Forgot the development images Newest and Oldest * Uniform timezone behaviour * shellcheck * A bit more documentation
2022-05-31Docker readme volume for extensions (#4397)Gravatar Alexandre Alapetite
* Docker readme volume for extensions Forgotten from https://github.com/FreshRSS/FreshRSS/pull/4320 Keeping https://github.com/FreshRSS/FreshRSS/pull/2837 * Minor whitespace * No extension volume for development
2022-05-23Custom logo HTML (#4369)Gravatar Alexandre Alapetite
* Custom logo HTML Add option for custom HTML logo/title in the main Web UI view. Can potentially be different per user. #fix https://github.com/FreshRSS/FreshRSS/pull/3830/files#r850472247 * logo_html in main config With new `./data/config.custom.php` to provide custom values before install * Docker documentation * whitespace * Auto relax CSP to allow images for HTML logo * Documentation
2022-04-24Update Docker readme (#4320)Gravatar Alexandre Alapetite
* Update Docker readme #fix https://github.com/FreshRSS/FreshRSS/issues/3351 * A few more headers https://github.com/FreshRSS/FreshRSS/issues/3649 https://doc.traefik.io/traefik/middlewares/http/headers/ * Another docker logs example * More uniform * Minor details
2022-01-08Use typographic quotes (#4133)Gravatar Alexandre Alapetite
* 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
2021-11-14Docker: Move logic to disable FreshRSS updates (#3973)Gravatar Alexandre Alapetite
Should be done during build and not during entrypoint, to avoid modifying a potential volume (e.g. mounting the source code as a volume is used during development).
2021-10-24Docker: don't add crontab unless needed. (#3927)Gravatar Chris Francy
Adding the crontab as part of the image build makes it more complicated to add custom entries to the crontab. Adjusting the image and entrypoint to make it so that the crontab is only added when CRON_MIN is set simplifies having a custom crontab.
2021-10-23Improved markdownlint (#3918)Gravatar Alexandre Alapetite
* 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-23Remove references to Ubuntu image in Docker/Readme.md (#3917)Gravatar Chris Francy
FreshRSS switched to Debian as the parent For the Image but there were still a couple references in the README to Ubuntu.
2021-08-14Use environment variables (#3756)Gravatar caminsha
* Add .env file for docker-compose (fix #3755) Adding a .env has the advantage that the configuration can be stored in a separate file and it'll be possible to just get the newest docker-compose.yml file. * Update documentation for the .env file * Update Docker/README.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-07-25[docs] fix the cron container terminates upon start (#3718)Gravatar proletarius101
2021-03-15Quick update the doc for master renaming to edgeGravatar Alexandre Alapetite
2021-02-11Fix nginx config (#3438)Gravatar Creak
* Fix nginx config * Remove `proxy_cookie_path` * Add `proxy_set_header X-Forwarded-Prefix` for the subdirectory config * Add nginx config when hosted as domain root * Add `/` at the end of `proxy_pass`
2020-08-29More changelog, Docker readmeGravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/pull/3159
2020-05-14fixes #2931 (#2970)Gravatar Mike Vanbuskirk
2020-05-06Fix tty error on cron with docker (#2954)Gravatar pofilo
* Fix tty error on cron with docker * remove interactive option in cron command
2020-04-21Fix minor typo in Docker README (#2921)Gravatar Frans de Jonge
2020-04-21#2671 Apache reverse proxy (#2919)Gravatar Twilek-de
* #2671 Apache reverse proxy Adding sample configuration for using apache as a reverse proxy * Update Docker/README.md Better wording Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com> * Update Docker/README.md Better wording Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com> * Included suggestions and cleaned up code I have cleaned the code with the <location> Tags so that it is more concise * Included corrections * Update Docker/README.md Minor port number Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-03-22New core-extensions to allow Docker volumes for third-party extensions (#2837)Gravatar Alexandre Alapetite
* New core-extensions to allow Docker volumes for third-party extensions #Fix https://github.com/FreshRSS/FreshRSS/issues/2650 Split our extensions directory into two: 1) Core extensions shipped with FreshRSS in ./lib/core-extensions/ 2) Third-party extensions modified by end-users in ./extensions/ which can easily be mounted as a Docker volume * Example of Docker Compose with extensions * Back-compatibility + fix array merge bug
2019-11-06Fix database autocreate at install (#2635)Gravatar Alexandre Alapetite
* Fix database autocreate at install Several bugs prevented the auto-creation of the database in Web and CLI installs. Fix https://github.com/YunoHost-Apps/freshrss_ynh/issues/84#issuecomment-549818408 * initDb https://github.com/FreshRSS/FreshRSS/pull/2635#discussion_r343107795
2019-11-05Cookie same-site (#2630)Gravatar Alexandre Alapetite
* Set-Cookie SameSite * https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00 * https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-02#section-5.3.7 * https://blog.mozilla.org/security/2018/04/24/same-site-cookies-in-firefox-60/ * https://blog.chromium.org/2019/10/developers-get-ready-for-new.html Set to Lax instead of Strict to allow linking to allow linking to FreshRSS sub-pages without having to log-in again
2019-10-17#2573 remove trailing slash to prevent normalizing by nginx (#2574)Gravatar Pim Snel
2019-10-01Trim whitespace (#2544)Gravatar Alexandre Alapetite
2019-09-25Explicit Traefik 1.7 (#2533)Gravatar Alexandre Alapetite
Traefik 2.0 has some breaking changes. Making the use of version 1.7 explicit while waiting for upgrading to 2.0 https://community.containo.us/t/traefik-release-v2-0-0/1628
2019-08-22Minz: New environment variable to control development mode (#2508)Gravatar Alexandre Alapetite
* New environment variable to control development mode Suggestion of new enviromnent variable, as discussed https://github.com/FreshRSS/FreshRSS/pull/2492#issuecomment-523613920 * Update Docker/README.md Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com> * Update Docker/README.md Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com> * Update Docker/README.md Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com> * Declare ENV in Dockerfile Tested
2019-08-17Doc MariaDB (#2494)Gravatar Alexandre Alapetite
2019-08-16Docker readme cleanups (#2483)Gravatar Sandro
* Don't manually pull the base image * Remove sudo before each docker cause the user is usually added to the docker group If not you can read it up here: https://docs.docker.com/install/linux/linux-postinstall/ * Simplify cd