v2 - GitLite

v2

(★ 9,603)

Minimalist and opinionated feed reader

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- docker-compose.yml
- - bug_report.yml
  - config.yml
  - documentation.yml
  - feature_request.yml
  - feed_issue.yml
  - proposal.yml
- - build_binaries.yml
  - codeberg_mirror.yml
  - codeql-analysis.yml
  - debian_packages.yml
  - docker.yml
  - linters.yml
  - rpm_packages.yml
  - stale.yml
  - tests.yml
- dependabot.yml
- pull_request_template.md
- client.go
- client_test.go
- doc.go
- model.go
- options.go
- README.md
- request.go
- - README.md
- - basic.yml
  - caddy.yml
  - Caddyfile
  - README.md
  - traefik.yml
- - dashboard.json
  - README.md
- - README.md
- - collection.json
  - README.md
- README.md
- - api.go
  - api_integration_test.go
  - api_key_handlers.go
  - api_test.go
  - category_handlers.go
  - enclosure_handlers.go
  - entry_handlers.go
  - feed_handlers.go
  - icon_handlers.go
  - messages.go
  - middleware.go
  - opml_handlers.go
  - subscription_handlers.go
  - user_handlers.go
  - version_handler.go
- - ask_credentials.go
  - cleanup_tasks.go
  - cli.go
  - create_admin.go
  - daemon.go
  - export_feeds.go
  - flush_sessions.go
  - health_check.go
  - info.go
  - logger.go
  - refresh_feeds.go
  - reset_password.go
  - scheduler.go
- - config.go
  - options.go
  - options_parsing_test.go
  - parser.go
  - parser_test.go
  - validators.go
  - validators_test.go
- - crypto.go
- - database.go
  - migrations.go
  - postgresql.go
- - handler.go
  - middleware.go
  - README.md
  - response.go
- - handler.go
  - item.go
  - item_test.go
  - middleware.go
  - parameters.go
  - prefix_suffix.go
  - README.md
  - request_modifier.go
  - response.go
  - stream.go
- - integration.go
  - integration_test.go
- - catalog.go
  - catalog_test.go
  - error.go
  - error_test.go
  - locale.go
  - locale_test.go
  - plural.go
  - plural_test.go
  - printer.go
  - printer_test.go
- - media_proxy_test.go
  - rewriter.go
  - url.go
- - metric.go
- - api_key.go
  - categories_sort_options.go
  - category.go
  - enclosure.go
  - enclosure_test.go
  - entry.go
  - feed.go
  - feed_test.go
  - home_page.go
  - icon.go
  - integration.go
  - job.go
  - model.go
  - subscription.go
  - theme.go
  - user.go
  - web_session.go
  - web_session_test.go
  - webauthn.go
- - authorization.go
  - google.go
  - manager.go
  - oidc.go
  - profile.go
  - provider.go
- - proxyrotator.go
  - proxyrotator_test.go
- - api_key.go
  - batch.go
  - category.go
  - certificate_cache.go
  - enclosure.go
  - entry.go
  - entry_pagination_builder.go
  - entry_query_builder.go
  - entry_test.go
  - feed.go
  - feed_query_builder.go
  - icon.go
  - integration.go
  - nav_metadata.go
  - storage.go
  - user.go
  - web_session.go
  - webauthn.go
- - systemd.go
- - engine.go
  - engine_test.go
  - functions.go
  - functions_test.go
- - timezone.go
  - timezone_test.go
- - about.go
  - api_key_create.go
  - api_key_list.go
  - api_key_remove.go
  - api_key_save.go
  - auth.go
  - auth_proxy_middleware.go
  - category_create.go
  - category_edit.go
  - category_entries.go
  - category_entries_all.go
  - category_entries_starred.go
  - category_feeds.go
  - category_list.go
  - category_mark_as_read.go
  - category_mark_feed_as_read.go
  - category_refresh.go
  - category_remove.go
  - category_remove_feed.go
  - category_save.go
  - category_update.go
  - csrf_middleware.go
  - entry_category.go
  - entry_enclosure_save_position.go
  - entry_feed.go
  - entry_read.go
  - entry_save.go
  - entry_scraper.go
  - entry_search.go
  - entry_starred.go
  - entry_tag.go
  - entry_toggle_starred.go
  - entry_unread.go
  - entry_update_status.go
  - feed_edit.go
  - feed_entries.go
  - feed_entries_all.go
  - feed_icon.go
  - feed_list.go
  - feed_mark_as_read.go
  - feed_refresh.go
  - feed_remove.go
  - feed_update.go
  - handler.go
  - history_entries.go
  - history_flush.go
  - integration_show.go
  - integration_update.go
  - login_check.go
  - login_show.go
  - logout.go
  - oauth2_callback.go
  - oauth2_redirect.go
  - oauth2_unlink.go
  - offline.go
  - opml_export.go
  - opml_import.go
  - opml_upload.go
  - pagination.go
  - proxy.go
  - routes.go
  - search.go
  - session_list.go
  - session_remove.go
  - settings_show.go
  - settings_update.go
  - share.go
  - shared_entries.go
  - starred_entries.go
  - starred_entry_category.go
  - static_app_icon.go
  - static_favicon.go
  - static_javascript.go
  - static_manifest.go
  - static_stylesheet.go
  - subscription_add.go
  - subscription_bookmarklet.go
  - subscription_choose.go
  - subscription_submit.go
  - tag_entries_all.go
  - ui.go
  - unread_entries.go
  - unread_entry_category.go
  - unread_entry_feed.go
  - unread_mark_all_read.go
  - user_create.go
  - user_edit.go
  - user_list.go
  - user_remove.go
  - user_save.go
  - user_update.go
  - web_session_middleware.go
  - webauthn.go
- - url.go
  - url_test.go
- - api_key.go
  - category.go
  - enclosure.go
  - enclosure_test.go
  - entry.go
  - entry_test.go
  - feed.go
  - feed_test.go
  - filter.go
  - filter_test.go
  - subscription.go
  - subscription_test.go
  - user.go
  - user_test.go
  - validator.go
  - validator_test.go
- - version.go
  - version_test.go
- - pool.go
  - pool_test.go
  - worker.go
- - build.sh
  - compat
  - control
  - copyright
  - Dockerfile
  - miniflux.dirs
  - miniflux.manpages
  - miniflux.postinst
  - rules
- - Dockerfile
  - miniflux.spec
- - miniflux.service
- miniflux.conf
.gitignore
.golangci.yml
CONTRIBUTING.md
go.mod
go.sum
LICENSE
main.go
Makefile
miniflux.1
Procfile
README.md
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/miniflux/v2

Downloads the entire project code from GitHub to your computer.

cd v2

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.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f packaging/debian/Dockerfile -t v2 .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 v2

Runs the built image as an actual container.

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

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. 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.

v2

File Explorer

# Installation Guide

2. Docker

3. Go

4. Make

Today's picks

Was this content helpful?

Recent Feedback

v2

File Explorer

# Installation Guide

2. Docker

3. Go

4. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README