pict-rs-aggregator/README.md

1.9 KiB

pict-rs-aggregator

a simple image aggregator for pict-rs

Usage

Running

pict-rs-aggregator 0.1.9

USAGE:
    pict-rs-aggregator [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -a, --addr <addr>                      The address and port the server binds to [env: PICTRS_AGGREGATOR_ADDR=]
                                           [default: 0.0.0.0:8082]
    -d, --database-path <database-path>    The path to the database [env: PICTRS_AGGREGATOR_DATABASE=]  [default:
                                           sled/db-0-34]
    -u, --upstream <upstream>              The url of the upstream pict-rs server [env: PICTRS_AGGREGATOR_UPSTREAM=]
                                           [default: http://localhost:8080]

Examples

Running on all interfaces, port 8082, aggregatoring to localhost:8080

$ ./pict-rs-aggregator

Running locally, port 9000, aggregatoring to localhost:4000, with a database in /tmp

$ ./pict-rs-aggregator -a 127.0.0.1:9000 -u localhost:4000 -d /tmp/

Contributing

Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the AGPLv3.

License

Copyright © 2021 Riley Trautman

pict-rs-aggregator is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

pict-rs-aggregator is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of pict-rs.

You should have received a copy of the GNU General Public License along with pict-rs. If not, see http://www.gnu.org/licenses/.