Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
112 lines (86 sloc) 5.05 KB

Installation Instructions

Packages

Platform Type Repository URL
Debian/Ubuntu Upstream (Binary) https://github.com/miniflux/package-deb
RHEL/Fedora Upstream (Binary) https://github.com/miniflux/package-rpm
Docker Image Upstream (Binary) https://github.com/miniflux/docker
Arch Linux Community (Source) https://aur.archlinux.org/packages/miniflux/
FreeBSD Port Community (Source) www/miniflux

You can download precompiled binaries and packages on the releases page: https://github.com/miniflux/miniflux/releases. You could also :ref:`build the application from the source code <build-sources>`.

Manual Installation

  1. Copy the binary somewhere
  2. Make the file executable: chmod +x miniflux
  3. Define the environment variable DATABASE_URL if necessary
  4. CREATE EXTENSION hstore in the database or specify a user with SUPERUSER privileges. (:ref:`Details <migrations-superuser>`)
  5. Run the SQL migrations: miniflux -migrate
  6. Create an admin user: miniflux -create-admin
  7. Start the application: miniflux

You should configure a process manager like systemd or supervisord to supervise the Miniflux daemon. The Debian or RPM packages are doing that for you.

Debian Package Installation

You must have Debian >= 8 or Ubuntu >= 16.04. When using the Debian package, the Miniflux daemon is supervised by systemd.

  1. Install Debian package: dpkg -i miniflux_2.0.13_amd64.deb
  2. Check process status: systemctl status miniflux
  3. Define the environment variable DATABASE_URL if necessary
  4. Run the SQL migrations: miniflux -migrate
  5. Create an admin user: miniflux -create-admin

Systemd reads the :ref:`environment variables <env-variables>` from the file /etc/miniflux.conf. You must restart the service to take the new values into consideration.

RPM Package Installation

You must have Fedora or Centos/Redhat >= 7. When you use the RPM package, the Miniflux daemon is supervised by systemd.

  1. Install Miniflux RPM: rpm -ivh miniflux-2.0.13-1.0.x86_64.rpm
  2. Define the environment variable DATABASE_URL if necessary
  3. Run the SQL migrations: miniflux -migrate
  4. Create an admin user: miniflux -create-admin
  5. Enable the systemd service: systemctl enable miniflux
  6. Start the process with systemd: systemctl start miniflux
  7. Check process status: systemctl status miniflux

Systemd reads the :ref:`environment variables <env-variables>` from the file /etc/miniflux.conf. You must restart the service to take the new values into consideration.

Docker Usage

Pull the image and run the container: docker run -d -p 80:8080 miniflux/miniflux:version (Replace version). You will probably need to pass some environment variables like the DATABASE_URL.

You could also use Docker Compose. Here an example of docker-compose.yml file:

version: '3'
services:
  miniflux:
    image: miniflux/miniflux:latest
    ports:
      - "80:8080"
    depends_on:
      - db
    environment:
      - DATABASE_URL=postgres://miniflux:secret@db/miniflux?sslmode=disable
  db:
    image: postgres:10.1
    environment:
      - POSTGRES_USER=miniflux
      - POSTGRES_PASSWORD=secret
    volumes:
      - miniflux-db:/var/lib/postgresql/data
volumes:
  miniflux-db:

Remember that you still need to run the database migrations and create the first user:

# Run database migrations
docker exec -ti <container-name> /usr/local/bin/miniflux -migrate

# Create the first user
docker exec -ti <container-name> /usr/local/bin/miniflux -create-admin

Another way of doing the same thing is to populate the variables RUN_MIGRATIONS, CREATE_ADMIN, ADMIN_USERNAME and ADMIN_PASSWORD.