https://github.com/deafmute1/refeed

Monitors an imap mailbox and converts incoming email matching filters to atom/rss feeds.
https://github.com/deafmute1/refeed

Last synced: 5 months ago
JSON representation

Monitors an imap mailbox and converts incoming email matching filters to atom/rss feeds.

• Host: GitHub
• URL: https://github.com/deafmute1/refeed
• Owner: deafmute1
• License: lgpl-3.0
• Archived: true
• Created: 2020-12-21T06:51:21.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-15T01:25:33.000Z (over 4 years ago)
• Last Synced: 2024-11-21T19:38:47.782Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 55.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - deafmute1/refeed - Monitors an imap mailbox and converts incoming email matching filters to atom/rss feeds. (Python)

README

          
**UNDER CONSTRUCTION**

# REFEED 

# Install 

## Bare

1. Install required distro packages (note that on some very minimal install, more than this may be required; also that some packages may have different names on your distro.)

    

    `python3-pip` 

    The minimum installed python verison is at least 3.7, although 3.8 or 3.9 are more likely to be compatible. 

2. Get the latest release and install it to a location of your choice (e.g. /opt): 

    

    `cd /opt && wget  -O - | tar -xz -C /opt/refeed `

    Or install from git master:

    

    `cd /opt && sudo git clone https://github.com/deafmute1/refeed.git`

3. Install required pip packages (preferrably into a virtual env, if you are an end user consider using `pipx`): 

    `cd /opt/refeed && pip3 install -r min_requirements.txt`

   

    For devs, use `dev_requirements.txt`. 

4. Setup your refeed config in a location of your choice (default is (from git root) /run/config.yaml), and run refeed: 

     `python3 /opt/refeed/refeed.py   & `

    

    You may want to setup a systemd service file or find some other way to autostart refeed.

    

    See [below](https://github.com/deafmute1/docker-calibredb#config.yaml) to setup your config file. 

  

5. Point a web server to whatever you have set the static directory as (default /run/static)

    

    *TODO: Add some instructions for nginx/apache* 

## Docker 

  *TODO*  

## config.yaml 

  *TODO - just copy the contents of config.example.yaml ? *