A simple web UI for aggregating images with pict-rs

Go to file

asonix be541164bb Bump version		2022-06-21 10:45:16 -05:00
.cargo	Re-enable console, actix-web 4.0 stable	2022-02-26 12:33:49 -06:00
docker	Fix dockerfile tag	2021-12-19 14:10:53 -06:00
scss	Improve entry href placement	2022-06-20 21:38:22 -05:00
src	Simplify direction logic	2022-06-21 10:44:46 -05:00
static	Initial commit	2020-12-08 16:03:18 -06:00
templates	Improve pending image state	2022-06-21 10:44:39 -05:00
.drone.yml	Bump deps	2021-12-28 11:00:48 -06:00
.gitignore	Initial commit	2020-12-08 16:03:18 -06:00
Cargo.lock	Bump version	2022-06-21 10:45:16 -05:00
Cargo.toml	Bump version	2022-06-21 10:45:16 -05:00
LICENSE	Make database path configurable, update Cargo.toml, add License	2021-09-06 16:02:28 -05:00
README.md	Use clap directly	2022-05-28 11:53:46 -05:00

README.md

pict-rs-aggregator

a simple image aggregator for pict-rs

Usage

Running

pict-rs-aggregator 

USAGE:
    pict-rs-aggregator [OPTIONS]

OPTIONS:
    -a, --addr <ADDR>
            The address and port the server binds to [env: PICTRS_AGGREGATOR_ADDR=] [default:
            0.0.0.0:8082]

    -c, --console-event-buffer-size <CONSOLE_EVENT_BUFFER_SIZE>
            The number of events to buffer in console. When unset, console is disabled [env:
            PICTRS_AGGREGATOR_CONSOLE_EVENT_BUFFER_SIZE=]

    -d, --database-path <DATABASE_PATH>
            The path to the database [env: PICTRS_AGGREGATOR_DATABASE=] [default: sled/db-0-34]

    -h, --help
            Print help information

    -o, --opentelemetry-url <OPENTELEMETRY_URL>
            URL for the OpenTelemetry Colletor [env: PICTRS_AGGREGATOR_OPENTELEMETRY_URL=]

    -s, --sled-cache-capacity <SLED_CACHE_CAPACITY>
            The amount of RAM, in bytes, that sled is allowed to consume. Increasing this value can
            improve performance [env: PICTRS_AGGREGATOR_SLED_CACHE_CAPACITY=] [default: 67108864]

    -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

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/.