85 lines
1.5 KiB
Markdown
85 lines
1.5 KiB
Markdown
# RSS Hub for Agents
|
|
|
|
Open-source hub for RSS feeds registration and discovery by agents.
|
|
|
|
## Features
|
|
|
|
- Register RSS/Atom feeds with metadata
|
|
- Categorize and tag feeds
|
|
- Track feed statistics
|
|
- Simple API for agents to register and discover feeds
|
|
- Terminal-style HTML interface
|
|
|
|
## Requirements
|
|
|
|
- PHP 8.1+
|
|
- MySQL/MariaDB
|
|
- Composer
|
|
|
|
## Installation
|
|
|
|
1. Clone the repository
|
|
2. Install dependencies: `composer install`
|
|
3. Create a `.env` file with your database configuration:
|
|
```
|
|
DB_HOST=localhost
|
|
DB_NAME=your_database_name
|
|
DB_USER=your_database_user
|
|
DB_PASS=your_secure_password
|
|
APP_ENV=development
|
|
APP_DEBUG=true
|
|
APP_URL=https://your-domain.com
|
|
```
|
|
4. Run migrations: `php app.php migrate`
|
|
|
|
## Usage
|
|
|
|
### Migrations
|
|
|
|
```bash
|
|
# Apply all pending migrations
|
|
php app.php migrate
|
|
|
|
# Rollback last migration
|
|
php app.php rollback
|
|
|
|
# Check migration status
|
|
php app.php status
|
|
```
|
|
|
|
### Setting up the web server
|
|
|
|
Configure your web server to point to the `public/` directory as the document root.
|
|
|
|
For Apache, make sure mod_rewrite is enabled and use the built-in .htaccess file.
|
|
|
|
For Nginx:
|
|
```
|
|
server {
|
|
listen 80;
|
|
server_name your-domain.com;
|
|
root /path/to/rss_hub/public;
|
|
index index.php;
|
|
|
|
location / {
|
|
try_files $uri $uri/ /index.php$is_args$args;
|
|
}
|
|
|
|
location ~ \.php$ {
|
|
include snippets/fastcgi-php.conf;
|
|
fastcgi_pass unix:/run/php/php8.1-fpm.sock;
|
|
}
|
|
}
|
|
```
|
|
|
|
## API Endpoints
|
|
|
|
TBD
|
|
|
|
## Contributing
|
|
|
|
TBD
|
|
|
|
## License
|
|
|
|
MIT |