Files
newsgo/README.md

47 lines
1.6 KiB
Markdown
Raw Normal View History

2022-12-06 22:27:15 +00:00
newsgo
======
2022-12-06 19:17:06 +00:00
2022-12-11 16:10:31 +00:00
I2P News Server Tool/Library. A whole lot faster than the python one. Otherwise compatible.
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
Usage
-----
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
./newsgo -command $command -newsdir $news_directory -statsfile $news_stats_file
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
### Commands
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
- serve: Serve newsfeeds from a directory
2022-12-11 16:10:31 +00:00
- build: Build newsfeeds from XML
- sign: Sign newsfeeds with local keys
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
### Options
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
Use these options to configure the software
2022-12-06 19:17:06 +00:00
2022-12-11 00:48:43 +00:00
#### Server Options(use with `serve`)
2022-12-06 19:17:06 +00:00
2022-12-06 22:27:15 +00:00
- `-newsdir`: directory to serve newsfeed from
- `-statsfile`: file to store the stats in, in json format
- `-host`: host to serve news files on
- `-port`: port to serve news files on
2022-12-11 00:55:21 +00:00
- `-http`: serve news on host:port using HTTP
2022-12-06 22:27:15 +00:00
- `-i2p`: serve news files directly to I2P using SAMv3
2022-12-06 19:17:06 +00:00
2022-12-11 00:48:43 +00:00
#### Builder Options(use with `build`)
2022-12-06 19:17:06 +00:00
2022-12-11 00:48:43 +00:00
- `-newsfile`: entries to pass to news generator. If passed a directory, all `entries.html` files in the directory will be processed
- `-blockfile`: block list file to pass to news generator
- `-releasejson`: json file describing an update to pass to news generator
- `-feedtitle`: title to use for the RSS feed to pass to news generator
- `-feedsubtitle`: subtitle to use for the RSS feed to pass to news generator
- `-feedsite`: site for the RSS feed to pass to news generator
- `-feedmain`: Primary newsfeed for updates to pass to news generator
- `-feedbackup`: Backup newsfeed for updates to pass to news generator
- `-feeduri`: UUID to use for the RSS feed to pass to news generator
- `-builddir`: directory to output XML files in
2022-12-06 19:17:06 +00:00
2022-12-11 00:48:43 +00:00
#### Signer Options(use with `sign`)
2022-12-06 19:17:06 +00:00
- `-signerid`: ID of the news signer
- `-signingkey`: path to the signing key