diff options
| -rw-r--r-- | README.md | 58 | ||||
| -rw-r--r-- | readme.html | 69 |
2 files changed, 112 insertions, 15 deletions
@@ -17,7 +17,6 @@ </pre> <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again --> -**Table of Contents** - [Neko](#neko) - [Features](#features) @@ -34,6 +33,7 @@ - [Crawl Feeds](#crawl-feeds) - [Export](#export) - [All Command Line Options](#all-command-line-options) +- [Configuration File](#configuration-file) - [TODO](#todo) - [History](#history) - [Early 2017](#early-2017) @@ -93,16 +93,22 @@ A `neko` binary should now be in `$GOPATH/bin/`. By default this is usually `$HO # Configuration -There's no configuration file -- everything is handled with a few command line flags. You shouldn't need to change the defaults most of the time. +Everything can handled with a few command line flags. You shouldn't need to change the defaults most of the time. + +You can also set options using a configuration file [`yaml`](http://yaml.org), described at the end of this README (but you probably don't need to.) ## Storage By default `neko` will create the file `neko.db` in the current directory for storage. -You can override the location of this database file with the `--database` command line option. +You can override the location of this database file with the `--database` command line option or `-d` short option. $ neko --database=/var/db/neko.db --add=http://trenchant.org/rss.xml +which is equivalent to -- + + $ neko -d /var/db/neko.db --add=http://trenchant.org/rss.xml + For expert users -- this is a [SQLite](https://sqlite.org/) database and can be manipulated with standard sqlite commands -- $ sqlite3 neko.db .schema @@ -162,16 +168,20 @@ View all command line options with `-h` or `--help` Usage of neko: -a, --add http://example.com/rss.xml add the feed at URL http://example.com/rss.xml + -c, --config string + read configuration from file -d, --database string - sqlite database file (default "neko.db") + sqlite database file -x, --export string export feed. format required: text, json or opml -h, --help print usage information -s, --http int - HTTP port to serve on (default 4994) + HTTP port to serve on -i, --imageproxy rewrite and proxy all image requests for privacy (experimental) + -m, --minutes int + minutes between crawling feeds -p, --password string password to access web interface -u, --update @@ -179,10 +189,44 @@ Usage of neko: -v, --verbose verbose output +These are POSIX style flags so -- + + $ neko --minutes=120 + +is equivalent to + + $ neko -m 120 + +# Configuration File + +For convenience, you can specify options in a configuration file. + + $ neko -c /etc/neko.conf + +A subset of the command line options are supported in the configuration file, with the same semantics -- + + * database + * http + * imageproxy + * minutes + * password + +For example -- + +``` +database: /var/db/neko.db +http: 9001 +imageproxy: true +minutes: 90 +password: VeryLongRandomStringBecauseSecurityIsFun + +``` + + # TODO - * manually initiate crawl/refresh from web interface - * auto-refresh feeds from web interface + * manually initiate crawl/refresh from web interface (done: /crawl/) + * auto-refresh feeds from web interface (wip: but may not be working right) * import * mark all as read * rewrite frontend in a modern js framework diff --git a/readme.html b/readme.html index b47955b..9269faf 100644 --- a/readme.html +++ b/readme.html @@ -27,8 +27,6 @@ article { padding: 30px; } -<p><strong>Table of Contents</strong></p> - <ul> <li><a href="#neko" rel="nofollow">Neko</a> @@ -60,6 +58,7 @@ article { padding: 30px; } <li><a href="#export" rel="nofollow">Export</a></li> </ul></li> <li><a href="#all-command-line-options" rel="nofollow">All Command Line Options</a></li> +<li><a href="#configuration-file" rel="nofollow">Configuration File</a></li> <li><a href="#todo" rel="nofollow">TODO</a></li> <li><a href="#history" rel="nofollow">History</a> @@ -133,17 +132,24 @@ Dependencies</h3> <h1><a name="configuration" class="anchor" href="#configuration" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Configuration</h1> -<p>There's no configuration file -- everything is handled with a few command line flags. You shouldn't need to change the defaults most of the time.</p> +<p>Everything can handled with a few command line flags. You shouldn't need to change the defaults most of the time.</p> + +<p>You can also set options using a configuration file <a href="http://yaml.org" rel="nofollow"><code>yaml</code></a>, described at the end of this README (but you probably don't need to.)</p> <h2><a name="storage" class="anchor" href="#storage" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Storage</h2> <p>By default <code>neko</code> will create the file <code>neko.db</code> in the current directory for storage.</p> -<p>You can override the location of this database file with the <code>--database</code> command line option.</p> +<p>You can override the location of this database file with the <code>--database</code> command line option or <code>-d</code> short option.</p> <pre><code>$ neko --database=/var/db/neko.db --add=http://trenchant.org/rss.xml </code></pre> +<p>which is equivalent to --</p> + +<pre><code>$ neko -d /var/db/neko.db --add=http://trenchant.org/rss.xml +</code></pre> + <p>For expert users -- this is a <a href="https://sqlite.org/" rel="nofollow">SQLite</a> database and can be manipulated with standard sqlite commands --</p> <pre><code>$ sqlite3 neko.db .schema @@ -214,9 +220,14 @@ All Command Line Options</h1> <pre><code> add the feed at URL http://example.com/rss.xml </code></pre> +<p>-c, --config string</p> + +<pre><code> read configuration from file +</code></pre> + <p>-d, --database string</p> -<pre><code> sqlite database file (default "neko.db") +<pre><code> sqlite database file </code></pre> <p>-x, --export string</p> @@ -231,7 +242,7 @@ All Command Line Options</h1> <p>-s, --http int</p> -<pre><code> HTTP port to serve on (default 4994) +<pre><code> HTTP port to serve on </code></pre> <p>-i, --imageproxy</p> @@ -239,6 +250,11 @@ All Command Line Options</h1> <pre><code> rewrite and proxy all image requests for privacy (experimental) </code></pre> +<p>-m, --minutes int</p> + +<pre><code> minutes between crawling feeds +</code></pre> + <p>-p, --password string</p> <pre><code> password to access web interface @@ -253,12 +269,49 @@ All Command Line Options</h1> <pre><code> verbose output </code></pre> + +<p>These are POSIX style flags so --</p> + +<pre><code>$ neko --minutes=120 +</code></pre> + +<p>is equivalent to</p> + +<pre><code>$ neko -m 120 +</code></pre> +<h1><a name="configuration-file" class="anchor" href="#configuration-file" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> +Configuration File</h1> + +<p>For convenience, you can specify options in a configuration file.</p> + +<pre><code>$ neko -c /etc/neko.conf +</code></pre> + +<p>A subset of the command line options are supported in the configuration file, with the same semantics --</p> + +<ul> +<li>database</li> +<li>http</li> +<li>imageproxy</li> +<li>minutes</li> +<li>password</li> +</ul> + +<p>For example --</p> + +<pre><code>database: /var/db/neko.db +http: 9001 +imageproxy: true +minutes: 90 +password: VeryLongRandomStringBecauseSecurityIsFun + +</code></pre> <h1><a name="todo" class="anchor" href="#todo" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> TODO</h1> <ul> -<li>manually initiate crawl/refresh from web interface</li> -<li>auto-refresh feeds from web interface</li> +<li>manually initiate crawl/refresh from web interface (done: /crawl/)</li> +<li>auto-refresh feeds from web interface (wip: but may not be working right)</li> <li>import</li> <li>mark all as read</li> <li>rewrite frontend in a modern js framework</li> |