How to Self-Host Miniflux on a VPS (Complete Guide)

Miniflux is a minimalist and RSS feed reader that allows you to aggregate and read your favorite web content from one place. Self-hosting it gives you full control of your data and allows customization. This guide will walk you through the steps to effectively self-host Miniflux on a VPS using Docker.

Why Choose Miniflux?

• Lightweight and Fast: Miniflux is designed to be simple and efficient.
• Open Source: It’s an open-source project that allows modifications and custom setups.
• Customizable: You can modify its behavior and appearance to suit your needs.

Prerequisites

Before diving into the installation, you’ll need:

1. A VPS from a reliable provider (see comparison below).
2. Basic knowledge of Docker and command-line interface.
3. A domain name (optional but recommended).
4. SSH access to your VPS.

Here are some popular VPS providers to consider:

For a full VPS comparison, check out full VPS comparison.

Step 1: Choose and Prepare Your VPS

Select a VPS provider based on your needs. For this guide, we recommend Contabo or Hetzner due to their balance of performance and cost. Once you have your VPS set up, connect via SSH:

ssh root@your-vps-ip

Step 2: Install Docker

Docker is crucial for running Miniflux. Follow the steps below to install Docker on your VPS:

# Update your package repository
sudo apt update

# Install necessary packages
sudo apt install -y apt-transport-https ca-certificates curl software-properties-common

# Add Docker’s official GPG key
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# Add Docker's APT repository
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

# Update package index again
sudo apt update

# Install Docker
sudo apt install -y docker-ce

# Check Docker installation
docker --version

Step 3: Pull and Run Miniflux Docker Image

Now that Docker is installed, you can pull the Miniflux image and run it:

# Pull the Miniflux image
docker pull miniflux/miniflux

# Run the Miniflux container
docker run -d \
  --name miniflux \
  -e MINIFLUX_DATABASE_URL=postgres://user:password@postgres/miniflux?sslmode=disable \
  -e MINIFLUX_PORT=8080 \
  -p 8080:8080 \
  miniflux/miniflux

Replace user and password with your PostgreSQL database credentials.

Step 4: Set Up the Database

For Miniflux to function, a PostgreSQL database needs to be set up:

# Install PostgreSQL
sudo apt install postgresql postgresql-contrib

# Start PostgreSQL service
sudo systemctl start postgresql

# Access PostgreSQL shell
sudo -u postgres psql

# Create Miniflux database and user
CREATE DATABASE miniflux;
CREATE USER user WITH PASSWORD 'password';
GRANT ALL PRIVILEGES ON DATABASE miniflux TO user;
\q

Step 5: Access Miniflux

With everything set up, you can now access Miniflux in your web browser. Navigate to http://your-vps-ip:8080. You will be greeted with the Miniflux interface, where you can configure your feeds.

Security Considerations

To secure your Miniflux installation, consider the following:

• Set up a reverse proxy with Nginx or Traefik to handle HTTPS.
• Regularly update your Docker containers.
• Use firewall rules to restrict access.

FAQs

How can I backup my Miniflux data?

Backing up your Miniflux data involves creating backups of the PostgreSQL database. You can use the following command to back up your database:

PGPASSWORD=password pg_dump -U user -h localhost miniflux > miniflux_backup.sql

Ensure that you run this command periodically, potentially through a cron job if possible. For full resilience, consider also using Docker volumes to persist Miniflux data. Familiarize yourself with the concepts in r/selfhosted for more backup strategies.

Can I customize the Miniflux interface?

Yes, Miniflux offers various customization options through its settings interface. You can adjust theme settings, modify layout choices, and add or remove feeds as per your preference.

For deeper customization, consider looking into the source code or contributing to the project on its GitHub repository. Engaging with the open-source community, such as awsome-selfhosted, can provide additional insights and customizations.

What are the advantages of using Docker for Miniflux?

Using Docker to run Miniflux provides various benefits. It simplifies the installation process and isolates the application, ensuring that it runs the same way regardless of the underlying environment. Docker makes versioning and dependencies management more straightforward, allowing for quick upgrades and rollbacks. Furthermore, you can quickly replicate your setup across other servers or machines.

Conclusion

Self-hosting Miniflux on a VPS gives you the flexibility and control over your RSS reading experience. By following this step-by-step guide, you can set up your Miniflux instance in no time. Keep your software updated and engage with the community to enhance your self-hosting journey. Enjoy reading your favorite feeds with Miniflux!