a simple example for pict-rs usage

Go to file

asonix 03e8b31f92 All checks were successful / check (aarch64-unknown-linux-musl) (push) Successful in 2m42s Details / clippy (push) Successful in 1m50s Details / tests (push) Successful in 2m17s Details / check (armv7-unknown-linux-musleabihf) (push) Successful in 2m44s Details / check (x86_64-unknown-linux-musl) (push) Successful in 2m36s Details Strip release binaries		2024-02-12 15:17:32 -06:00
.cargo	Re-enable console	2022-02-26 12:30:03 -06:00
.forgejo/workflows	Remove prerelease marker	2024-02-12 14:33:05 -06:00
docker	Remove old docker stuff	2024-02-11 14:55:00 -06:00
images	Images in readme	2020-06-17 18:33:45 -05:00
scss	Add video playback support, fix upload page on small screens	2021-01-05 10:43:48 -06:00
src	Remove dependency on once_cell	2024-02-01 17:22:19 -06:00
static	Use pict-rs's background uploading feature	2022-05-02 20:38:46 -05:00
templates	Remove dependency on once_cell	2024-02-01 17:22:19 -06:00
.gitignore	Add flake	2023-03-09 21:30:31 -06:00
Cargo.lock	Remove dependency on once_cell	2024-02-01 17:22:19 -06:00
Cargo.toml	Strip release binaries	2024-02-12 15:17:32 -06:00
flake.lock	Update flake	2024-02-01 22:13:34 -06:00
flake.nix	Update flake	2024-02-01 22:13:34 -06:00
LICENSE	Working noscript-compatible pict-rs frontend	2020-06-13 16:23:43 -05:00
pict-rs-proxy.nix	Update flake	2024-02-01 22:13:34 -06:00
README.md	Bump version	2022-09-28 18:36:42 -05:00

README.md

pict-rs-proxy

a demo frontend for pict-rs supporting noscript

Usage

Running

$ pict-rs-proxy -h
A simple web frontend for pict-rs

Usage: pict-rs-proxy [OPTIONS]

Options:
  -a, --addr <ADDR>
          The address and port the server binds to [env: PICTRS_PROXY_ADDR=] [default: 0.0.0.0:8081]
  -u, --upstream <UPSTREAM>
          The url of the upstream pict-rs server [env: PICTRS_PROXY_UPSTREAM=] [default: http://localhost:8080]
  -d, --domain <DOMAIN>
          The scheme, domain, and optional port of the pict-rs proxy server [env: PICTRS_PROXY_DOMAIN=] [default: http://localhost:8081]
      --console-event-buffer-size <CONSOLE_EVENT_BUFFER_SIZE>
          Number of events to buffer for the console subscriber. When unset, console will be disabled [env: PICTRS_PROXY_CONSOLE_BUFFER_SIZE=]
  -o, --opentelemetry-url <OPENTELEMETRY_URL>
          URL of OpenTelemetry Collector [env: PICTRS_PROXY_OPENTELEMETRY_URL=]
  -h, --help
          Print help information
  -V, --version
          Print version information

Examples

Running on all interfaces, port 8081, proxying to localhost:8080

$ ./pict-rs-proxy

Running locally, port 9000, proxying to localhost:4000

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

Docker production

# Create a folder for the files (anywhere works)
mkdir ./pict-rs-proxy
cd ./pict-rs-proxy
mkdir -p volumes/pictrs
sudo chown -R 991:991 volumes/pictrs
wget https://git.asonix.dog/asonix/pict-rs-proxy/raw/branch/main/docker/prod/docker-compose.yml
sudo docker-compose up -d

Docker development

git clone https://git.asonix.dog/asonix/pict-rs-proxy
cd pict-rs-proxy/docker/dev
docker-compose up --build

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