A simple web UI for aggregating images with pict-rs

Go to file

asonix 815783d0c9 All checks were successful / clippy (push) Successful in 1m45s Details / check (armv7-unknown-linux-musleabihf) (push) Successful in 3m12s Details / tests (push) Successful in 2m52s Details / check (aarch64-unknown-linux-musl) (push) Successful in 3m21s Details / check (x86_64-unknown-linux-musl) (push) Successful in 2m42s Details Strip release binaries		2024-02-12 15:17:09 -06:00
.cargo	Re-enable console, actix-web 4.0 stable	2022-02-26 12:33:49 -06:00
.forgejo/workflows	Remove prerelease marker	2024-02-12 14:33:36 -06:00
docker	Add forgejo dockerfile	2024-02-11 14:54:33 -06:00
scss	Backfill dimensions onto entry records to help browser layout	2023-11-13 15:38:00 -06:00
src	Enable serving over TLS, communicating to pict-rs over TLS	2024-02-01 18:14:29 -06:00
static	Initial commit	2020-12-08 16:03:18 -06:00
templates	Improve error messages, don't log as much stuff	2023-11-13 17:07:05 -06:00
.gitignore	Add flake	2023-03-09 21:51:22 -06:00
Cargo.lock	Bump version	2024-02-01 18:15:16 -06:00
Cargo.toml	Strip release binaries	2024-02-12 15:17:09 -06:00
flake.lock	Update flake	2024-02-01 22:14:32 -06:00
flake.nix	Update flake	2024-02-01 22:14:32 -06:00
LICENSE	Make database path configurable, update Cargo.toml, add License	2021-09-06 16:02:28 -05:00
pict-rs-aggregator.nix	Update flake	2024-02-01 22:14:32 -06:00
README.md	Bump dependencies, version	2022-09-28 18:43:28 -05:00

README.md

pict-rs-aggregator

a simple image aggregator for pict-rs

Usage

Running

$ pict-rs-aggregator -h
A simple image aggregation service for pict-rs

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]
  -u, --upstream <UPSTREAM>
          The url of the upstream pict-rs server [env: PICTRS_AGGREGATOR_UPSTREAM=] [default: http://localhost:8080]
  -d, --database-path <DATABASE_PATH>
          The path to the database [env: PICTRS_AGGREGATOR_DATABASE=] [default: sled/db-0-34]
  -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]
  -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=]
  -o, --opentelemetry-url <OPENTELEMETRY_URL>
          URL for the OpenTelemetry Colletor [env: PICTRS_AGGREGATOR_OPENTELEMETRY_URL=]
  -h, --help
          Print help information
  -V, --version
          Print version information

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