FreshRSS

(★ 15,806)

A free, self-hostable news aggregator…

File Explorer

ZIP Download

- .htaccess
- devcontainer.json
- Dockerfile
- postCreateCommand.sh
- README.md
- - _general.instructions.md
  - css.instructions.md
  - i18n.instructions.md
  - javascript.instructions.md
  - markdown.instructions.md
  - php.instructions.md
- - bug_report_form.yaml
  - feature_request.yaml
  - feed-report-form.yml
- - docker-publish.yml
  - dockerhub-description.yml
  - jekyll-gh-pages.yml
  - tests.yml
- .htaccess
- dependabot.yml
- FUNDING.yml
- - apiController.php
  - authController.php
  - categoryController.php
  - configureController.php
  - entryController.php
  - errorController.php
  - extensionController.php
  - feedController.php
  - importExportController.php
  - indexController.php
  - javascriptController.php
  - searchController.php
  - statsController.php
  - subscriptionController.php
  - tagController.php
  - updateController.php
  - userController.php
- - AlreadySubscribedException.php
  - BadUrlException.php
  - ContextException.php
  - EntriesGetterException.php
  - FeedException.php
  - FeedNotAddedException.php
  - UnsupportedImageFormatException.php
  - ZipException.php
  - ZipMissingException.php
- - aside_configure.phtml
  - aside_feed.phtml
  - aside_subscription.phtml
  - header.phtml
  - layout.phtml
  - nav_entries.phtml
  - nav_menu.phtml
- - UserMailer.php
- - .keep
- - ActionController.php
  - AttributesTrait.php
  - Auth.php
  - BooleanSearch.php
  - Category.php
  - CategoryDAO.php
  - CategoryDAOPGSQL.php
  - CategoryDAOSQLite.php
  - Context.php
  - DatabaseDAO.php
  - DatabaseDAOPGSQL.php
  - DatabaseDAOSQLite.php
  - Entry.php
  - EntryDAO.php
  - EntryDAOPGSQL.php
  - EntryDAOSQLite.php
  - Factory.php
  - Feed.php
  - FeedDAO.php
  - FeedDAOPGSQL.php
  - FeedDAOSQLite.php
  - FilterAction.php
  - FilterActionsTrait.php
  - FormAuth.php
  - Log.php
  - LogDAO.php
  - ReadingMode.php
  - Search.php
  - Share.php
  - SimplePieCustom.php
  - SimplePieFetch.php
  - StatsDAO.php
  - StatsDAOPGSQL.php
  - StatsDAOSQLite.php
  - SystemConfiguration.php
  - Tag.php
  - TagDAO.php
  - TagDAOPGSQL.php
  - TagDAOSQLite.php
  - Themes.php
  - UserConfiguration.php
  - UserDAO.php
  - UserQuery.php
  - View.php
  - ViewJavascript.php
  - ViewMode.php
  - ViewStats.php
- - ExportService.php
  - ImportService.php
- - install.sql.mysql.php
  - install.sql.pgsql.php
  - install.sql.sqlite.php
- - dotNotationUtil.php
  - feverUtil.php
  - httpUtil.php
  - passwordUtil.php
- .htaccess
- actualize_script.php
- FreshRSS.php
- index.html
- install.php
- shares.php
- - I18nCompletionValidator.php
  - I18nData.php
  - I18nFile.php
  - I18nUsageValidator.php
  - I18nValidatorInterface.php
  - I18nValue.php
  - PluralFormsCompiler.php
- .htaccess
- _cli.php
- access-permissions.sh
- actualize-user.php
- check.translation.php
- CliOption.php
- CliOptionsParser.php
- compile.plurals.php
- create-user.php
- db-backup.php
- db-optimize.php
- db-restore.php
- delete-user.php
- do-install.php
- export-opml-for-user.php
- export-sqlite-auto.php
- export-sqlite-for-user.php
- export-zip-for-user.php
- health.php
- import-for-user.php
- import-sqlite-for-user.php
- index.html
- list-users.php
- manipulate.translation.php
- prepare.php
- purge.php
- README.md
- reconfigure-user.php
- reconfigure.php
- sensitive-log.sh
- translation-update.sh
- update-user.php
- user-info.php
- - .gitignore
  - index.html
- - .gitignore
  - index.html
- - .gitignore
  - index.html
- - .gitignore
  - index.html
- - index.html
- - .gitignore
  - index.html
  - README.md
- - .gitignore
  - index.html
- - .gitignore
  - index.html
- .gitignore
- .htaccess
- index.html
- tos.example.html
- - docker-compose-db.yml
  - docker-compose-development.yml
  - docker-compose-local.yml
  - docker-compose-proxy.yml
  - docker-compose.yml
  - example.env
- .gitignore
- .htaccess
- Dockerfile
- Dockerfile-Alpine
- Dockerfile-Arch
- Dockerfile-Newest
- Dockerfile-Oldest
- entrypoint.sh
- FreshRSS.Apache.conf
- README.md
- - anchor_headings.html
  - docs.css
  - docs_nav.html
  - lang_dropdown.html
- - default.html
- - contributing.md
  - index.md
  - internationalization.md
- - contributing.md
  - index.md
  - internationalization.md
- - freshrss.fr.po
- - FreshRSS-logo-font.svg
  - FreshRSS-logo.png
  - FreshRSS-logo.svg
  - FreshRSS-screenshot.png
- .htaccess
- _config.yml
- CHANGELOG-old.md
- CHANGELOG-old2.md
- favicon.ico
- Gemfile
- Gemfile.lock
- index.md
- po4a.conf
- pull_request_template.md
- README.md
- search.en.json
- search.fr.json
- .gitignore
- .htaccess
- index.html
- README.md
- - README.md
- - ActionController.php
  - ActionException.php
  - Configuration.php
  - ConfigurationException.php
  - ConfigurationNamespaceException.php
  - ConfigurationParamException.php
  - ConfigurationSetterInterface.php
  - ControllerNotActionControllerException.php
  - ControllerNotExistException.php
  - CurrentPagePaginationException.php
  - Dispatcher.php
  - Error.php
  - Exception.php
  - Extension.php
  - ExtensionException.php
  - ExtensionManager.php
  - FileNotExistException.php
  - FrontController.php
  - Helper.php
  - Hook.php
  - HookSignature.php
  - HookType.php
  - Log.php
  - Mailer.php
  - Migrator.php
  - Model.php
  - ModelArray.php
  - ModelPdo.php
  - Paginator.php
  - Pdo.php
  - PDOConnectionException.php
  - PdoMysql.php
  - PdoPgsql.php
  - PdoSqlite.php
  - PermissionDeniedException.php
  - Request.php
  - Session.php
  - Translate.php
  - Url.php
  - User.php
  - View.php
- .gitignore
- .htaccess
- composer.json
- favicons.php
- http-conditional.php
- index.html
- lib_date.php
- lib_install.php
- lib_rss.php
- README.md
- - .htaccess
  - fever.php
  - greader.php
  - index.php
  - misc.php
  - pshb.php
  - query.php
- - .gitignore
  - index.php
- - api.js
  - category.js
  - config.js
  - draggable.js
  - extra.js
  - feed.js
  - global_view.js
  - install.js
  - integration.js
  - main.js
  - preview.js
  - statsWithChartjs.js
- - .gitignore
  - .htaccess
  - index.html
  - manifest.json
  - p.css
  - p.rtl.css
- .htaccess
- ext.php
- f.php
- favicon.ico
- index.html
- index.php
- robots.txt
- Web.config
- - cli-parser-test.php
  - CliOptionsParserTest.php
  - UserConfigOptionsParserTest.php
- - ActualizeMutexTest.php
  - InstallTest.php
  - LibDateTest.php
  - TranslateTest.php
- .gitignore
- .htaccess
- bootstrap.php
- index.html
- README.md
- shellchecks.sh
.dockerignore
.editorconfig
.gitattributes
.gitignore
.hadolint.yaml
.htaccess.dist
.jshintignore
.jshintrc
.markdownlint-cli2.jsonc
.stylelintignore
.stylelintrc.json
.typos.toml
AGENTS.md
CHANGELOG.md
composer.json
composer.lock
config-user.default.php
config.default.php
constants.php
CONTRIBUTING.md
CREDITS.md
eslint.config.js
force-https.default.txt
index.html
index.php
LICENSE.txt
Makefile
opml.default.xml
package-lock.json
package.json
phpcs.xml
phpstan-next.neon
phpstan.dist.neon
README.fr.md
README.md
SECURITY.md

# Installation Guide

php

Prerequisites

PHP 8.1+
Web Server (Apache2.4+ / nginx / lighttpd) Apache 2.4+
Database (PostgreSQL / SQLite / MySQL / MariaDB) PostgreSQL 10+ / MariaDB 10.6+ / MySQL 8.0+
PHP cURL Extension
PHP DOM Extension
PHP PDO Extension

Setup Steps

git clone https://github.com/FreshRSS/FreshRSS.git

Clone the repository to download source code.

composer install --no-dev

Install PHP dependencies using Composer.

chmod -R 755 ./data

Set permissions on the data folder for the webserver.

Key Commands

composer install --no-dev --optimize-autoloader

Install PHP dependency packages for the project.

docker compose -f ./Docker/freshrss/docker-compose.yml up -d

Run FreshRSS and database services in the background using Docker.

For better security, expose only the ./p/ folder to the Web and protect the ./data/ folder from public access.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

FreshRSS

Owner Repos

File Explorer

# Installation Guide

Setup Steps

Key Commands

# Use via CDN

Was this content helpful?

Recent Feedback

FreshRSS

Owner Repos

File Explorer

# Installation Guide

Setup Steps

Key Commands

# Use via CDN

Was this content helpful?

Recent Feedback

Download README