Add README.md

master
Mageas 1 year ago
parent 52168ad3f7
commit 75c6b3cf32
Signed by: Mageas
GPG Key ID: B45836562531E7AD
  1. 50
      README.md

@ -0,0 +1,50 @@
# **matrix_piped_feed**
Get your [piped](https://github.com/TeamPiped/Piped) notifications on matrix!
### **Configuration**
Copy `config_example.json` to `config.json`.
**credentials**:
- user: *Matrix account user*
- password: *Matrix account password*
- homeserver: *Matrix account homeserver*
**subscriptions**:
- room: *Id of the matrix room*
- feed: *Piped feed url*
**fetch_between**: (Optional, if not set it will fetch 24/7)
- start: *When the fetching starts (in 24 hours)*
- end: *When the fetching ends (in 24 hours)*
**fetch_interval**:
- Time between fetches (in seconds)
<br>
By default, the `config.json` and `database.db3` needs to be in the directory where you execute the binaries.
### **Environment variables**
`MATRIX_PIPED_FEED__CONFIG`: change the config path
`MATRIX_PIPED_FEED__DATABASE`: change the database path
### **Build the project**
Clone the repository:
```
git clone https://gitlab.com/Mageas/matrix_piped_feed
```
Once in the cloned directory, build the project for release:
```
cargo build --release
```
The binary is located in `./target/release/matrix_piped_feed`
### **Self-host**
I suggest you to use the [docker version](https://gitlab.com/Mageas/matrix_piped_feed_docker).
Loading…
Cancel
Save