freshrss-app/README.md

52 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2017-02-17 08:45:48 +00:00
# FreshRSS Cloudron App
This repository contains the Cloudron app package source for [FreshRSS](http://www.freshrss.org/).
## Installation
[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=org.freshrss.cloudronapp)
2017-02-18 12:00:48 +00:00
or using the [Cloudron command line tooling](https://git.cloudron.io/cloudron/cloudron-cli/)
2017-02-17 08:45:48 +00:00
```
cloudron install --appstore-id org.freshrss.cloudronapp
```
## Building
2017-02-18 12:00:48 +00:00
The app package can be built using the [Cloudron command line tooling](https://git.cloudron.io/cloudron/cloudron-cli/).
2017-02-17 08:45:48 +00:00
```
cd freshrss-app
cloudron build
cloudron install
```
## Testing
The e2e tests are located in the `test/` folder and require [nodejs](http://nodejs.org/). They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the repos are still ok. The tests expect port 29418 to be available.
```
cd freshrss-app/test
npm install
2017-06-01 08:43:49 +00:00
PATH=$PATH:node_modules/.bin mocha --bail test.js
2017-02-17 08:45:48 +00:00
```
2019-01-03 23:58:37 +00:00
## Debugging
* Update your data/config.php with the following, to get more debugging information:
```
'environment' => 'development',
```
* Check your logs:
* Web server / PHP logs
* FreshRSS API log in ./data/users/_/log_api.txt
* FreshRSS logs in ./data/users/you/log.txt