Skip to content

felixZmn/feedBox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FeedBox Logo

FeedBox

Put all your feeds into a box!

Latest Release Docker Image Helm Chart License

Desktop Light Mode

What is FeedBox?

FeedBox is a simple, self-hosted feed reader built with Java.
It allows you to manage all your feeds in one place—without ads, tracking, AI, or other distractions.

Features

⚠️ Currently in non-production state. Planned features include:

  • Simple UI with automatic dark mode
  • Mobile and desktop views
  • Fully self-hostable
  • Import and export feeds as OPML
  • Organize feeds into folders
  • Periodic background refresh

Getting Started

Local Development

Prerequisites:

  • PostgreSQL (e.g. via Docker)
  • Java
  • Maven

Build the application:

mvn clean install

Run the application:

PG_USER=user \
PG_PASSWORD=password \
PG_HOST=127.0.0.1 \
PG_PORT=5432 \
PG_DB=postgres \
java -jar target/feedBox.jar

Build and push Docker image:

VERSION=$(grep -m1 '<version>' pom.xml | sed -E 's/.*<version>([^<]+)<\/version>.*/\1/')

docker build -t ghcr.io/felixzmn/docker/feedbox:$VERSION -t ghcr.io/felixzmn/docker/feedbox:latest .
docker push ghcr.io/felixzmn/docker/feedbox:$VERSION
docker push ghcr.io/felixzmn/docker/feedbox:latest

Running with Docker

docker network create appnet

docker run -d --name postgres \
  -p 5432:5432 \
  -e POSTGRES_USER=user \
  -e POSTGRES_PASSWORD=password \
  -e POSTGRES_DB=postgres \
  --network appnet \
  postgres

docker run --rm --name feedbox \
  -p 7070:7070 \
  --network appnet \
  ghcr.io/felixzmn/docker/feedbox:latest

Helm Chart

Build the chart

cd chart
helm package .
helm push feedbox-*.tgz oci://ghcr.io/felixzmn/helm

Deploy to your cluster

helm install feedbox oci://ghcr.io/felixzmn/helm/feedbox --version <VERSION>

Configuration

Variable Required Description Default
PG_USER yes Database user
PG_PASSWORD yes Database password
PG_HOST yes Database host
PG_PORT yes Database port
PG_DB yes Database name
PORT no Application port 7070
REFRESH_RATE no Feed refresh interval 60min

Icons

Icons from Tabler Icons. PWA Icon generated with maskable

About

Put all your feeds into a box!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •