FreshRSS

(★ 15,806)

A free, self-hostable news aggregator…

File Explorer

Download Latest Version (.zip)
  • .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

1. Get the code
git clone https://github.com/FreshRSS/FreshRSS

Downloads the entire project code from GitHub to your computer.

cd FreshRSS

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f Docker/freshrss/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
composer install

Installs the PHP libraries listed in composer.json.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

5. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
cd docs

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

✅ If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

ui-ux-pro-max-skill ★ 117,300

An AI skill that provides design intelligence for building professional UI/UX across multi

Python
langchain ★ 144,349

The agent engineering platform.

Python
deno ★ 108,249

A modern runtime for JavaScript and TypeScript.

Rust
electron ★ 122,518

:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS

C++
react-native ★ 126,357

A framework for building native applications using React

C++
weekly ★ 100,534

科技爱好者周刊，每周五发布
// repository documentation