rumorsflow / rumors

Rumors is a news aggregator that parses RSS and sitemap XML

Welcome to Rumors, a news aggregation application that brings together the latest news and updates from various sources.

Rumors parses RSS and sitemap XML files to gather and organize news and information, making it easier for you to stay informed and up-to-date on the latest developments in your field of interest.

Bot commands

rumors - <index> <size> <search>
sites - List of available sites
sub - List of subscribed sites
on - subscribe <site>
off - unsubscribe <site>

Generate Swagger Documentation 2.0

Install swag

go install github.com/swaggo/swag/cmd/swag@aa3e8d5fa2f6ee3a56f54c7ae3bd18145783eaac

Run the following command to generate Front API Documentation

swag i -g swagger.go -dir internal/http/front,internal/entity,internal/model,${HOME}/go/pkg/mod/github.com/gowool/wool@v0.0.0-20230509175958-16e9f1d12396 --instanceName front

Run the following command to generate System API Documentation

swag i -g swagger.go -dir internal/http/sys,internal/entity,${HOME}/go/pkg/mod/github.com/gowool/wool@v0.0.0-20230509175958-16e9f1d12396 --instanceName sys

Generate a self-signed X.509 TLS certificate

Run the following command to generate cert.pem and key.pem files:

go run $GOROOT/src/crypto/tls/generate_cert.go --host localhost

Run the following command to generate RSA private key

openssl genrsa -out rsa_key.pem 4096

Docker Compose

# generate .env
cat > .env << "EOF"
RUMORS_TELEGRAM_TOKEN=<telegram bot token>
RUMORS_TELEGRAM_OWNER=<telegram owner ID>
RUMORS_HTTP_CERT_FILE=/absolute/path/cert.pem
RUMORS_HTTP_KEY_FILE=/absolute/path/key.pem
RUMORS_HTTP_JWT_PRIVATE_KEY=/absolute/path/rsa_key.pem
EOF

# start docker compose
docker compose up -d

# create new user and 2FA
docker compose exec rumors /rumors sys user create -u username -p password -e [e-mail]

License

Distributed under MIT License, please see license file within the code for more details.